"
- },
-
- _create: function() {
- this._tabify( true );
- },
-
- _setOption: function( key, value ) {
- if ( key == "selected" ) {
- if (this.options.collapsible && value == this.options.selected ) {
- return;
- }
- this.select( value );
- } else {
- this.options[ key ] = value;
- this._tabify();
- }
- },
-
- _tabId: function( a ) {
- return a.title && a.title.replace( /\s/g, "_" ).replace( /[^\w\u00c0-\uFFFF-]/g, "" ) ||
- this.options.idPrefix + getNextTabId();
- },
-
- _sanitizeSelector: function( hash ) {
- // we need this because an id may contain a ":"
- return hash.replace( /:/g, "\\:" );
- },
-
- _cookie: function() {
- var cookie = this.cookie ||
- ( this.cookie = this.options.cookie.name || "ui-tabs-" + getNextListId() );
- return $.cookie.apply( null, [ cookie ].concat( $.makeArray( arguments ) ) );
- },
-
- _ui: function( tab, panel ) {
- return {
- tab: tab,
- panel: panel,
- index: this.anchors.index( tab )
- };
- },
-
- _cleanup: function() {
- // restore all former loading tabs labels
- this.lis.filter( ".ui-state-processing" )
- .removeClass( "ui-state-processing" )
- .find( "span:data(label.tabs)" )
- .each(function() {
- var el = $( this );
- el.html( el.data( "label.tabs" ) ).removeData( "label.tabs" );
- });
- },
-
- _tabify: function( init ) {
- var self = this,
- o = this.options,
- fragmentId = /^#.+/; // Safari 2 reports '#' for an empty hash
-
- this.list = this.element.find( "ol,ul" ).eq( 0 );
- this.lis = $( " > li:has(a[href])", this.list );
- this.anchors = this.lis.map(function() {
- return $( "a", this )[ 0 ];
- });
- this.panels = $( [] );
-
- this.anchors.each(function( i, a ) {
- var href = $( a ).attr( "href" );
- // For dynamically created HTML that contains a hash as href IE < 8 expands
- // such href to the full page url with hash and then misinterprets tab as ajax.
- // Same consideration applies for an added tab with a fragment identifier
- // since a[href=#fragment-identifier] does unexpectedly not match.
- // Thus normalize href attribute...
- var hrefBase = href.split( "#" )[ 0 ],
- baseEl;
- if ( hrefBase && ( hrefBase === location.toString().split( "#" )[ 0 ] ||
- ( baseEl = $( "base" )[ 0 ]) && hrefBase === baseEl.href ) ) {
- href = a.hash;
- a.href = href;
- }
-
- // inline tab
- if ( fragmentId.test( href ) ) {
- self.panels = self.panels.add( self.element.find( self._sanitizeSelector( href ) ) );
- // remote tab
- // prevent loading the page itself if href is just "#"
- } else if ( href && href !== "#" ) {
- // required for restore on destroy
- $.data( a, "href.tabs", href );
-
- // TODO until #3808 is fixed strip fragment identifier from url
- // (IE fails to load from such url)
- $.data( a, "load.tabs", href.replace( /#.*$/, "" ) );
-
- var id = self._tabId( a );
- a.href = "#" + id;
- var $panel = self.element.find( "#" + id );
- if ( !$panel.length ) {
- $panel = $( o.panelTemplate )
- .attr( "id", id )
- .addClass( "ui-tabs-panel ui-widget-content ui-corner-bottom" )
- .insertAfter( self.panels[ i - 1 ] || self.list );
- $panel.data( "destroy.tabs", true );
- }
- self.panels = self.panels.add( $panel );
- // invalid tab href
- } else {
- o.disabled.push( i );
- }
- });
-
- // initialization from scratch
- if ( init ) {
- // attach necessary classes for styling
- this.element.addClass( "ui-tabs ui-widget ui-widget-content ui-corner-all" );
- this.list.addClass( "ui-tabs-nav ui-helper-reset ui-helper-clearfix ui-widget-header ui-corner-all" );
- this.lis.addClass( "ui-state-default ui-corner-top" );
- this.panels.addClass( "ui-tabs-panel ui-widget-content ui-corner-bottom" );
-
- // Selected tab
- // use "selected" option or try to retrieve:
- // 1. from fragment identifier in url
- // 2. from cookie
- // 3. from selected class attribute on
- if ( o.selected === undefined ) {
- if ( location.hash ) {
- this.anchors.each(function( i, a ) {
- if ( a.hash == location.hash ) {
- o.selected = i;
- return false;
- }
- });
- }
- if ( typeof o.selected !== "number" && o.cookie ) {
- o.selected = parseInt( self._cookie(), 10 );
- }
- if ( typeof o.selected !== "number" && this.lis.filter( ".ui-tabs-selected" ).length ) {
- o.selected = this.lis.index( this.lis.filter( ".ui-tabs-selected" ) );
- }
- o.selected = o.selected || ( this.lis.length ? 0 : -1 );
- } else if ( o.selected === null ) { // usage of null is deprecated, TODO remove in next release
- o.selected = -1;
- }
-
- // sanity check - default to first tab...
- o.selected = ( ( o.selected >= 0 && this.anchors[ o.selected ] ) || o.selected < 0 )
- ? o.selected
- : 0;
-
- // Take disabling tabs via class attribute from HTML
- // into account and update option properly.
- // A selected tab cannot become disabled.
- o.disabled = $.unique( o.disabled.concat(
- $.map( this.lis.filter( ".ui-state-disabled" ), function( n, i ) {
- return self.lis.index( n );
- })
- ) ).sort();
-
- if ( $.inArray( o.selected, o.disabled ) != -1 ) {
- o.disabled.splice( $.inArray( o.selected, o.disabled ), 1 );
- }
-
- // highlight selected tab
- this.panels.addClass( "ui-tabs-hide" );
- this.lis.removeClass( "ui-tabs-selected ui-state-active" );
- // check for length avoids error when initializing empty list
- if ( o.selected >= 0 && this.anchors.length ) {
- self.element.find( self._sanitizeSelector( self.anchors[ o.selected ].hash ) ).removeClass( "ui-tabs-hide" );
- this.lis.eq( o.selected ).addClass( "ui-tabs-selected ui-state-active" );
-
- // seems to be expected behavior that the show callback is fired
- self.element.queue( "tabs", function() {
- self._trigger( "show", null,
- self._ui( self.anchors[ o.selected ], self.element.find( self._sanitizeSelector( self.anchors[ o.selected ].hash ) )[ 0 ] ) );
- });
-
- this.load( o.selected );
- }
-
- // clean up to avoid memory leaks in certain versions of IE 6
- // TODO: namespace this event
- $( window ).bind( "unload", function() {
- self.lis.add( self.anchors ).unbind( ".tabs" );
- self.lis = self.anchors = self.panels = null;
- });
- // update selected after add/remove
- } else {
- o.selected = this.lis.index( this.lis.filter( ".ui-tabs-selected" ) );
- }
-
- // update collapsible
- // TODO: use .toggleClass()
- this.element[ o.collapsible ? "addClass" : "removeClass" ]( "ui-tabs-collapsible" );
-
- // set or update cookie after init and add/remove respectively
- if ( o.cookie ) {
- this._cookie( o.selected, o.cookie );
- }
-
- // disable tabs
- for ( var i = 0, li; ( li = this.lis[ i ] ); i++ ) {
- $( li )[ $.inArray( i, o.disabled ) != -1 &&
- // TODO: use .toggleClass()
- !$( li ).hasClass( "ui-tabs-selected" ) ? "addClass" : "removeClass" ]( "ui-state-disabled" );
- }
-
- // reset cache if switching from cached to not cached
- if ( o.cache === false ) {
- this.anchors.removeData( "cache.tabs" );
- }
-
- // remove all handlers before, tabify may run on existing tabs after add or option change
- this.lis.add( this.anchors ).unbind( ".tabs" );
-
- if ( o.event !== "mouseover" ) {
- var addState = function( state, el ) {
- if ( el.is( ":not(.ui-state-disabled)" ) ) {
- el.addClass( "ui-state-" + state );
- }
- };
- var removeState = function( state, el ) {
- el.removeClass( "ui-state-" + state );
- };
- this.lis.bind( "mouseover.tabs" , function() {
- addState( "hover", $( this ) );
- });
- this.lis.bind( "mouseout.tabs", function() {
- removeState( "hover", $( this ) );
- });
- this.anchors.bind( "focus.tabs", function() {
- addState( "focus", $( this ).closest( "li" ) );
- });
- this.anchors.bind( "blur.tabs", function() {
- removeState( "focus", $( this ).closest( "li" ) );
- });
- }
-
- // set up animations
- var hideFx, showFx;
- if ( o.fx ) {
- if ( $.isArray( o.fx ) ) {
- hideFx = o.fx[ 0 ];
- showFx = o.fx[ 1 ];
- } else {
- hideFx = showFx = o.fx;
- }
- }
-
- // Reset certain styles left over from animation
- // and prevent IE's ClearType bug...
- function resetStyle( $el, fx ) {
- $el.css( "display", "" );
- if ( !$.support.opacity && fx.opacity ) {
- $el[ 0 ].style.removeAttribute( "filter" );
- }
- }
-
- // Show a tab...
- var showTab = showFx
- ? function( clicked, $show ) {
- $( clicked ).closest( "li" ).addClass( "ui-tabs-selected ui-state-active" );
- $show.hide().removeClass( "ui-tabs-hide" ) // avoid flicker that way
- .animate( showFx, showFx.duration || "normal", function() {
- resetStyle( $show, showFx );
- self._trigger( "show", null, self._ui( clicked, $show[ 0 ] ) );
- });
- }
- : function( clicked, $show ) {
- $( clicked ).closest( "li" ).addClass( "ui-tabs-selected ui-state-active" );
- $show.removeClass( "ui-tabs-hide" );
- self._trigger( "show", null, self._ui( clicked, $show[ 0 ] ) );
- };
-
- // Hide a tab, $show is optional...
- var hideTab = hideFx
- ? function( clicked, $hide ) {
- $hide.animate( hideFx, hideFx.duration || "normal", function() {
- self.lis.removeClass( "ui-tabs-selected ui-state-active" );
- $hide.addClass( "ui-tabs-hide" );
- resetStyle( $hide, hideFx );
- self.element.dequeue( "tabs" );
- });
- }
- : function( clicked, $hide, $show ) {
- self.lis.removeClass( "ui-tabs-selected ui-state-active" );
- $hide.addClass( "ui-tabs-hide" );
- self.element.dequeue( "tabs" );
- };
-
- // attach tab event handler, unbind to avoid duplicates from former tabifying...
- this.anchors.bind( o.event + ".tabs", function() {
- var el = this,
- $li = $(el).closest( "li" ),
- $hide = self.panels.filter( ":not(.ui-tabs-hide)" ),
- $show = self.element.find( self._sanitizeSelector( el.hash ) );
-
- // If tab is already selected and not collapsible or tab disabled or
- // or is already loading or click callback returns false stop here.
- // Check if click handler returns false last so that it is not executed
- // for a disabled or loading tab!
- if ( ( $li.hasClass( "ui-tabs-selected" ) && !o.collapsible) ||
- $li.hasClass( "ui-state-disabled" ) ||
- $li.hasClass( "ui-state-processing" ) ||
- self.panels.filter( ":animated" ).length ||
- self._trigger( "select", null, self._ui( this, $show[ 0 ] ) ) === false ) {
- this.blur();
- return false;
- }
-
- o.selected = self.anchors.index( this );
-
- self.abort();
-
- // if tab may be closed
- if ( o.collapsible ) {
- if ( $li.hasClass( "ui-tabs-selected" ) ) {
- o.selected = -1;
-
- if ( o.cookie ) {
- self._cookie( o.selected, o.cookie );
- }
-
- self.element.queue( "tabs", function() {
- hideTab( el, $hide );
- }).dequeue( "tabs" );
-
- this.blur();
- return false;
- } else if ( !$hide.length ) {
- if ( o.cookie ) {
- self._cookie( o.selected, o.cookie );
- }
-
- self.element.queue( "tabs", function() {
- showTab( el, $show );
- });
-
- // TODO make passing in node possible, see also http://dev.jqueryui.com/ticket/3171
- self.load( self.anchors.index( this ) );
-
- this.blur();
- return false;
- }
- }
-
- if ( o.cookie ) {
- self._cookie( o.selected, o.cookie );
- }
-
- // show new tab
- if ( $show.length ) {
- if ( $hide.length ) {
- self.element.queue( "tabs", function() {
- hideTab( el, $hide );
- });
- }
- self.element.queue( "tabs", function() {
- showTab( el, $show );
- });
-
- self.load( self.anchors.index( this ) );
- } else {
- throw "jQuery UI Tabs: Mismatching fragment identifier.";
- }
-
- // Prevent IE from keeping other link focussed when using the back button
- // and remove dotted border from clicked link. This is controlled via CSS
- // in modern browsers; blur() removes focus from address bar in Firefox
- // which can become a usability and annoying problem with tabs('rotate').
- if ( $.browser.msie ) {
- this.blur();
- }
- });
-
- // disable click in any case
- this.anchors.bind( "click.tabs", function(){
- return false;
- });
- },
-
- _getIndex: function( index ) {
- // meta-function to give users option to provide a href string instead of a numerical index.
- // also sanitizes numerical indexes to valid values.
- if ( typeof index == "string" ) {
- index = this.anchors.index( this.anchors.filter( "[href$=" + index + "]" ) );
- }
-
- return index;
- },
-
- destroy: function() {
- var o = this.options;
-
- this.abort();
-
- this.element
- .unbind( ".tabs" )
- .removeClass( "ui-tabs ui-widget ui-widget-content ui-corner-all ui-tabs-collapsible" )
- .removeData( "tabs" );
-
- this.list.removeClass( "ui-tabs-nav ui-helper-reset ui-helper-clearfix ui-widget-header ui-corner-all" );
-
- this.anchors.each(function() {
- var href = $.data( this, "href.tabs" );
- if ( href ) {
- this.href = href;
- }
- var $this = $( this ).unbind( ".tabs" );
- $.each( [ "href", "load", "cache" ], function( i, prefix ) {
- $this.removeData( prefix + ".tabs" );
- });
- });
-
- this.lis.unbind( ".tabs" ).add( this.panels ).each(function() {
- if ( $.data( this, "destroy.tabs" ) ) {
- $( this ).remove();
- } else {
- $( this ).removeClass([
- "ui-state-default",
- "ui-corner-top",
- "ui-tabs-selected",
- "ui-state-active",
- "ui-state-hover",
- "ui-state-focus",
- "ui-state-disabled",
- "ui-tabs-panel",
- "ui-widget-content",
- "ui-corner-bottom",
- "ui-tabs-hide"
- ].join( " " ) );
- }
- });
-
- if ( o.cookie ) {
- this._cookie( null, o.cookie );
- }
-
- return this;
- },
-
- add: function( url, label, index ) {
- if ( index === undefined ) {
- index = this.anchors.length;
- }
-
- var self = this,
- o = this.options,
- $li = $( o.tabTemplate.replace( /#\{href\}/g, url ).replace( /#\{label\}/g, label ) ),
- id = !url.indexOf( "#" ) ? url.replace( "#", "" ) : this._tabId( $( "a", $li )[ 0 ] );
-
- $li.addClass( "ui-state-default ui-corner-top" ).data( "destroy.tabs", true );
-
- // try to find an existing element before creating a new one
- var $panel = self.element.find( "#" + id );
- if ( !$panel.length ) {
- $panel = $( o.panelTemplate )
- .attr( "id", id )
- .data( "destroy.tabs", true );
- }
- $panel.addClass( "ui-tabs-panel ui-widget-content ui-corner-bottom ui-tabs-hide" );
-
- if ( index >= this.lis.length ) {
- $li.appendTo( this.list );
- $panel.appendTo( this.list[ 0 ].parentNode );
- } else {
- $li.insertBefore( this.lis[ index ] );
- $panel.insertBefore( this.panels[ index ] );
- }
-
- o.disabled = $.map( o.disabled, function( n, i ) {
- return n >= index ? ++n : n;
- });
-
- this._tabify();
-
- if ( this.anchors.length == 1 ) {
- o.selected = 0;
- $li.addClass( "ui-tabs-selected ui-state-active" );
- $panel.removeClass( "ui-tabs-hide" );
- this.element.queue( "tabs", function() {
- self._trigger( "show", null, self._ui( self.anchors[ 0 ], self.panels[ 0 ] ) );
- });
-
- this.load( 0 );
- }
-
- this._trigger( "add", null, this._ui( this.anchors[ index ], this.panels[ index ] ) );
- return this;
- },
-
- remove: function( index ) {
- index = this._getIndex( index );
- var o = this.options,
- $li = this.lis.eq( index ).remove(),
- $panel = this.panels.eq( index ).remove();
-
- // If selected tab was removed focus tab to the right or
- // in case the last tab was removed the tab to the left.
- if ( $li.hasClass( "ui-tabs-selected" ) && this.anchors.length > 1) {
- this.select( index + ( index + 1 < this.anchors.length ? 1 : -1 ) );
- }
-
- o.disabled = $.map(
- $.grep( o.disabled, function(n, i) {
- return n != index;
- }),
- function( n, i ) {
- return n >= index ? --n : n;
- });
-
- this._tabify();
-
- this._trigger( "remove", null, this._ui( $li.find( "a" )[ 0 ], $panel[ 0 ] ) );
- return this;
- },
-
- enable: function( index ) {
- index = this._getIndex( index );
- var o = this.options;
- if ( $.inArray( index, o.disabled ) == -1 ) {
- return;
- }
-
- this.lis.eq( index ).removeClass( "ui-state-disabled" );
- o.disabled = $.grep( o.disabled, function( n, i ) {
- return n != index;
- });
-
- this._trigger( "enable", null, this._ui( this.anchors[ index ], this.panels[ index ] ) );
- return this;
- },
-
- disable: function( index ) {
- index = this._getIndex( index );
- var self = this, o = this.options;
- // cannot disable already selected tab
- if ( index != o.selected ) {
- this.lis.eq( index ).addClass( "ui-state-disabled" );
-
- o.disabled.push( index );
- o.disabled.sort();
-
- this._trigger( "disable", null, this._ui( this.anchors[ index ], this.panels[ index ] ) );
- }
-
- return this;
- },
-
- select: function( index ) {
- index = this._getIndex( index );
- if ( index == -1 ) {
- if ( this.options.collapsible && this.options.selected != -1 ) {
- index = this.options.selected;
- } else {
- return this;
- }
- }
- this.anchors.eq( index ).trigger( this.options.event + ".tabs" );
- return this;
- },
-
- load: function( index ) {
- index = this._getIndex( index );
- var self = this,
- o = this.options,
- a = this.anchors.eq( index )[ 0 ],
- url = $.data( a, "load.tabs" );
-
- this.abort();
-
- // not remote or from cache
- if ( !url || this.element.queue( "tabs" ).length !== 0 && $.data( a, "cache.tabs" ) ) {
- this.element.dequeue( "tabs" );
- return;
- }
-
- // load remote from here on
- this.lis.eq( index ).addClass( "ui-state-processing" );
-
- if ( o.spinner ) {
- var span = $( "span", a );
- span.data( "label.tabs", span.html() ).html( o.spinner );
- }
-
- this.xhr = $.ajax( $.extend( {}, o.ajaxOptions, {
- url: url,
- success: function( r, s ) {
- self.element.find( self._sanitizeSelector( a.hash ) ).html( r );
-
- // take care of tab labels
- self._cleanup();
-
- if ( o.cache ) {
- $.data( a, "cache.tabs", true );
- }
-
- self._trigger( "load", null, self._ui( self.anchors[ index ], self.panels[ index ] ) );
- try {
- o.ajaxOptions.success( r, s );
- }
- catch ( e ) {}
- },
- error: function( xhr, s, e ) {
- // take care of tab labels
- self._cleanup();
-
- self._trigger( "load", null, self._ui( self.anchors[ index ], self.panels[ index ] ) );
- try {
- // Passing index avoid a race condition when this method is
- // called after the user has selected another tab.
- // Pass the anchor that initiated this request allows
- // loadError to manipulate the tab content panel via $(a.hash)
- o.ajaxOptions.error( xhr, s, index, a );
- }
- catch ( e ) {}
- }
- } ) );
-
- // last, so that load event is fired before show...
- self.element.dequeue( "tabs" );
-
- return this;
- },
-
- abort: function() {
- // stop possibly running animations
- this.element.queue( [] );
- this.panels.stop( false, true );
-
- // "tabs" queue must not contain more than two elements,
- // which are the callbacks for the latest clicked tab...
- this.element.queue( "tabs", this.element.queue( "tabs" ).splice( -2, 2 ) );
-
- // terminate pending requests from other tabs
- if ( this.xhr ) {
- this.xhr.abort();
- delete this.xhr;
- }
-
- // take care of tab labels
- this._cleanup();
- return this;
- },
-
- url: function( index, url ) {
- this.anchors.eq( index ).removeData( "cache.tabs" ).data( "load.tabs", url );
- return this;
- },
-
- length: function() {
- return this.anchors.length;
- }
-});
-
-$.extend( $.ui.tabs, {
- version: "1.8.14"
-});
-
-/*
- * Tabs Extensions
- */
-
-/*
- * Rotate
- */
-$.extend( $.ui.tabs.prototype, {
- rotation: null,
- rotate: function( ms, continuing ) {
- var self = this,
- o = this.options;
-
- var rotate = self._rotate || ( self._rotate = function( e ) {
- clearTimeout( self.rotation );
- self.rotation = setTimeout(function() {
- var t = o.selected;
- self.select( ++t < self.anchors.length ? t : 0 );
- }, ms );
-
- if ( e ) {
- e.stopPropagation();
- }
- });
-
- var stop = self._unrotate || ( self._unrotate = !continuing
- ? function(e) {
- if (e.clientX) { // in case of a true click
- self.rotate(null);
- }
- }
- : function( e ) {
- t = o.selected;
- rotate();
- });
-
- // start rotation
- if ( ms ) {
- this.element.bind( "tabsshow", rotate );
- this.anchors.bind( o.event + ".tabs", stop );
- rotate();
- // stop rotation
- } else {
- clearTimeout( self.rotation );
- this.element.unbind( "tabsshow", rotate );
- this.anchors.unbind( o.event + ".tabs", stop );
- delete this._rotate;
- delete this._unrotate;
- }
-
- return this;
- }
-});
-
-})( jQuery );
\ No newline at end of file
diff --git a/Source/JavaScript/scripts.chirp.config b/Source/JavaScript/scripts.chirp.config
deleted file mode 100644
index e1b4599..0000000
--- a/Source/JavaScript/scripts.chirp.config
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/Source/JavaScript/survey-all.js b/Source/JavaScript/survey-all.js
index ba1dce0..98f29d1 100644
--- a/Source/JavaScript/survey-all.js
+++ b/Source/JavaScript/survey-all.js
@@ -1,13379 +1,483 @@
-/*
- http://www.JSON.org/json2.js
- 2011-02-23
-
- Public Domain.
-
- NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
-
- See http://www.JSON.org/js.html
-
-
- This code should be minified before deployment.
- See http://javascript.crockford.com/jsmin.html
-
- USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
- NOT CONTROL.
-
-
- This file creates a global JSON object containing two methods: stringify
- and parse.
-
- JSON.stringify(value, replacer, space)
- value any JavaScript value, usually an object or array.
-
- replacer an optional parameter that determines how object
- values are stringified for objects. It can be a
- function or an array of strings.
-
- space an optional parameter that specifies the indentation
- of nested structures. If it is omitted, the text will
- be packed without extra whitespace. If it is a number,
- it will specify the number of spaces to indent at each
- level. If it is a string (such as '\t' or ' '),
- it contains the characters used to indent at each level.
-
- This method produces a JSON text from a JavaScript value.
-
- When an object value is found, if the object contains a toJSON
- method, its toJSON method will be called and the result will be
- stringified. A toJSON method does not serialize: it returns the
- value represented by the name/value pair that should be serialized,
- or undefined if nothing should be serialized. The toJSON method
- will be passed the key associated with the value, and this will be
- bound to the value
-
- For example, this would serialize Dates as ISO strings.
-
- Date.prototype.toJSON = function (key) {
- function f(n) {
- // Format integers to have at least two digits.
- return n < 10 ? '0' + n : n;
- }
-
- return this.getUTCFullYear() + '-' +
- f(this.getUTCMonth() + 1) + '-' +
- f(this.getUTCDate()) + 'T' +
- f(this.getUTCHours()) + ':' +
- f(this.getUTCMinutes()) + ':' +
- f(this.getUTCSeconds()) + 'Z';
- };
-
- You can provide an optional replacer method. It will be passed the
- key and value of each member, with this bound to the containing
- object. The value that is returned from your method will be
- serialized. If your method returns undefined, then the member will
- be excluded from the serialization.
-
- If the replacer parameter is an array of strings, then it will be
- used to select the members to be serialized. It filters the results
- such that only members with keys listed in the replacer array are
- stringified.
-
- Values that do not have JSON representations, such as undefined or
- functions, will not be serialized. Such values in objects will be
- dropped; in arrays they will be replaced with null. You can use
- a replacer function to replace those with JSON values.
- JSON.stringify(undefined) returns undefined.
-
- The optional space parameter produces a stringification of the
- value that is filled with line breaks and indentation to make it
- easier to read.
-
- If the space parameter is a non-empty string, then that string will
- be used for indentation. If the space parameter is a number, then
- the indentation will be that many spaces.
-
- Example:
-
- text = JSON.stringify(['e', {pluribus: 'unum'}]);
- // text is '["e",{"pluribus":"unum"}]'
-
-
- text = JSON.stringify(['e', {pluribus: 'unum'}], null, '\t');
- // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'
-
- text = JSON.stringify([new Date()], function (key, value) {
- return this[key] instanceof Date ?
- 'Date(' + this[key] + ')' : value;
- });
- // text is '["Date(---current time---)"]'
-
-
- JSON.parse(text, reviver)
- This method parses a JSON text to produce an object or array.
- It can throw a SyntaxError exception.
-
- The optional reviver parameter is a function that can filter and
- transform the results. It receives each of the keys and values,
- and its return value is used instead of the original value.
- If it returns what it received, then the structure is not modified.
- If it returns undefined then the member is deleted.
-
- Example:
-
- // Parse the text. Values that look like ISO date strings will
- // be converted to Date objects.
-
- myData = JSON.parse(text, function (key, value) {
- var a;
- if (typeof value === 'string') {
- a =
-/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
- if (a) {
- return new Date(Date.UTC(+a[1], +a[2] - 1, +a[3], +a[4],
- +a[5], +a[6]));
- }
- }
- return value;
- });
-
- myData = JSON.parse('["Date(09/09/2001)"]', function (key, value) {
- var d;
- if (typeof value === 'string' &&
- value.slice(0, 5) === 'Date(' &&
- value.slice(-1) === ')') {
- d = new Date(value.slice(5, -1));
- if (d) {
- return d;
- }
- }
- return value;
- });
-
-
- This is a reference implementation. You are free to copy, modify, or
- redistribute.
-*/
-
-/*jslint evil: true, strict: false, regexp: false */
-
-/*members "", "\b", "\t", "\n", "\f", "\r", "\"", JSON, "\\", apply,
- call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
- getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
- lastIndex, length, parse, prototype, push, replace, slice, stringify,
- test, toJSON, toString, valueOf
-*/
-
-
-// Create a JSON object only if one does not already exist. We create the
-// methods in a closure to avoid creating global variables.
-
-var JSON;
-if (!JSON) {
- JSON = {};
-}
-
-(function () {
- "use strict";
-
- function f(n) {
- // Format integers to have at least two digits.
- return n < 10 ? '0' + n : n;
- }
-
- if (typeof Date.prototype.toJSON !== 'function') {
-
- Date.prototype.toJSON = function (key) {
-
- return isFinite(this.valueOf()) ?
- this.getUTCFullYear() + '-' +
- f(this.getUTCMonth() + 1) + '-' +
- f(this.getUTCDate()) + 'T' +
- f(this.getUTCHours()) + ':' +
- f(this.getUTCMinutes()) + ':' +
- f(this.getUTCSeconds()) + 'Z' : null;
- };
-
- String.prototype.toJSON =
- Number.prototype.toJSON =
- Boolean.prototype.toJSON = function (key) {
- return this.valueOf();
- };
- }
-
- var cx = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
- escapable = /[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
- gap,
- indent,
- meta = { // table of character substitutions
- '\b': '\\b',
- '\t': '\\t',
- '\n': '\\n',
- '\f': '\\f',
- '\r': '\\r',
- '"' : '\\"',
- '\\': '\\\\'
- },
- rep;
-
-
- function quote(string) {
-
-// If the string contains no control characters, no quote characters, and no
-// backslash characters, then we can safely slap some quotes around it.
-// Otherwise we must also replace the offending characters with safe escape
-// sequences.
-
- escapable.lastIndex = 0;
- return escapable.test(string) ? '"' + string.replace(escapable, function (a) {
- var c = meta[a];
- return typeof c === 'string' ? c :
- '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
- }) + '"' : '"' + string + '"';
- }
-
-
- function str(key, holder) {
-
-// Produce a string from holder[key].
-
- var i, // The loop counter.
- k, // The member key.
- v, // The member value.
- length,
- mind = gap,
- partial,
- value = holder[key];
-
-// If the value has a toJSON method, call it to obtain a replacement value.
-
- if (value && typeof value === 'object' &&
- typeof value.toJSON === 'function') {
- value = value.toJSON(key);
- }
-
-// If we were called with a replacer function, then call the replacer to
-// obtain a replacement value.
-
- if (typeof rep === 'function') {
- value = rep.call(holder, key, value);
- }
-
-// What happens next depends on the value's type.
-
- switch (typeof value) {
- case 'string':
- return quote(value);
-
- case 'number':
-
-// JSON numbers must be finite. Encode non-finite numbers as null.
-
- return isFinite(value) ? String(value) : 'null';
-
- case 'boolean':
- case 'null':
-
-// If the value is a boolean or null, convert it to a string. Note:
-// typeof null does not produce 'null'. The case is included here in
-// the remote chance that this gets fixed someday.
-
- return String(value);
-
-// If the type is 'object', we might be dealing with an object or an array or
-// null.
-
- case 'object':
-
-// Due to a specification blunder in ECMAScript, typeof null is 'object',
-// so watch out for that case.
-
- if (!value) {
- return 'null';
- }
-
-// Make an array to hold the partial results of stringifying this object value.
-
- gap += indent;
- partial = [];
-
-// Is the value an array?
-
- if (Object.prototype.toString.apply(value) === '[object Array]') {
-
-// The value is an array. Stringify every element. Use null as a placeholder
-// for non-JSON values.
-
- length = value.length;
- for (i = 0; i < length; i += 1) {
- partial[i] = str(i, value) || 'null';
- }
-
-// Join all of the elements together, separated with commas, and wrap them in
-// brackets.
-
- v = partial.length === 0 ? '[]' : gap ?
- '[\n' + gap + partial.join(',\n' + gap) + '\n' + mind + ']' :
- '[' + partial.join(',') + ']';
- gap = mind;
- return v;
- }
-
-// If the replacer is an array, use it to select the members to be stringified.
-
- if (rep && typeof rep === 'object') {
- length = rep.length;
- for (i = 0; i < length; i += 1) {
- if (typeof rep[i] === 'string') {
- k = rep[i];
- v = str(k, value);
- if (v) {
- partial.push(quote(k) + (gap ? ': ' : ':') + v);
- }
- }
- }
- } else {
-
-// Otherwise, iterate through all of the keys in the object.
-
- for (k in value) {
- if (Object.prototype.hasOwnProperty.call(value, k)) {
- v = str(k, value);
- if (v) {
- partial.push(quote(k) + (gap ? ': ' : ':') + v);
- }
- }
- }
- }
-
-// Join all of the member texts together, separated with commas,
-// and wrap them in braces.
-
- v = partial.length === 0 ? '{}' : gap ?
- '{\n' + gap + partial.join(',\n' + gap) + '\n' + mind + '}' :
- '{' + partial.join(',') + '}';
- gap = mind;
- return v;
- }
- }
-
-// If the JSON object does not yet have a stringify method, give it one.
-
- if (typeof JSON.stringify !== 'function') {
- JSON.stringify = function (value, replacer, space) {
-
-// The stringify method takes a value and an optional replacer, and an optional
-// space parameter, and returns a JSON text. The replacer can be a function
-// that can replace values, or an array of strings that will select the keys.
-// A default replacer method can be provided. Use of the space parameter can
-// produce text that is more easily readable.
-
- var i;
- gap = '';
- indent = '';
-
-// If the space parameter is a number, make an indent string containing that
-// many spaces.
-
- if (typeof space === 'number') {
- for (i = 0; i < space; i += 1) {
- indent += ' ';
- }
-
-// If the space parameter is a string, it will be used as the indent string.
-
- } else if (typeof space === 'string') {
- indent = space;
- }
-
-// If there is a replacer, it must be a function or an array.
-// Otherwise, throw an error.
-
- rep = replacer;
- if (replacer && typeof replacer !== 'function' &&
- (typeof replacer !== 'object' ||
- typeof replacer.length !== 'number')) {
- throw new Error('JSON.stringify');
- }
-
-// Make a fake root object containing our value under the key of ''.
-// Return the result of stringifying the value.
-
- return str('', {'': value});
- };
- }
-
-
-// If the JSON object does not yet have a parse method, give it one.
-
- if (typeof JSON.parse !== 'function') {
- JSON.parse = function (text, reviver) {
-
-// The parse method takes a text and an optional reviver function, and returns
-// a JavaScript value if the text is a valid JSON text.
-
- var j;
-
- function walk(holder, key) {
-
-// The walk method is used to recursively walk the resulting structure so
-// that modifications can be made.
-
- var k, v, value = holder[key];
- if (value && typeof value === 'object') {
- for (k in value) {
- if (Object.prototype.hasOwnProperty.call(value, k)) {
- v = walk(value, k);
- if (v !== undefined) {
- value[k] = v;
- } else {
- delete value[k];
- }
- }
- }
- }
- return reviver.call(holder, key, value);
- }
-
-
-// Parsing happens in four stages. In the first stage, we replace certain
-// Unicode characters with escape sequences. JavaScript handles many characters
-// incorrectly, either silently deleting them, or treating them as line endings.
-
- text = String(text);
- cx.lastIndex = 0;
- if (cx.test(text)) {
- text = text.replace(cx, function (a) {
- return '\\u' +
- ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
- });
- }
-
-// In the second stage, we run the text against regular expressions that look
-// for non-JSON patterns. We are especially concerned with '()' and 'new'
-// because they can cause invocation, and '=' because it can cause mutation.
-// But just to be safe, we want to reject all unexpected forms.
-
-// We split the second stage into 4 regexp operations in order to work around
-// crippling inefficiencies in IE's and Safari's regexp engines. First we
-// replace the JSON backslash pairs with '@' (a non-JSON character). Second, we
-// replace all simple value tokens with ']' characters. Third, we delete all
-// open brackets that follow a colon or comma or that begin the text. Finally,
-// we look to see that the remaining characters are only whitespace or ']' or
-// ',' or ':' or '{' or '}'. If that is so, then the text is safe for eval.
-
- if (/^[\],:{}\s]*$/
- .test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, '@')
- .replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']')
- .replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) {
-
-// In the third stage we use the eval function to compile the text into a
-// JavaScript structure. The '{' operator is subject to a syntactic ambiguity
-// in JavaScript: it can begin a block or an object literal. We wrap the text
-// in parens to eliminate the ambiguity.
-
- j = eval('(' + text + ')');
-
-// In the optional fourth stage, we recursively walk the new structure, passing
-// each name/value pair to a reviver function for possible transformation.
-
- return typeof reviver === 'function' ?
- walk({'': j}, '') : j;
- }
-
-// If the text is not JSON parseable, then a SyntaxError is thrown.
-
- throw new SyntaxError('JSON.parse');
- };
- }
-}());
-
-/*!
- * jQuery UI 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI
- */
-(function( $, undefined ) {
-
-// prevent duplicate loading
-// this is only a problem because we proxy existing functions
-// and we don't want to double proxy them
-$.ui = $.ui || {};
-if ( $.ui.version ) {
- return;
-}
-
-$.extend( $.ui, {
- version: "1.8.14",
-
- keyCode: {
- ALT: 18,
- BACKSPACE: 8,
- CAPS_LOCK: 20,
- COMMA: 188,
- COMMAND: 91,
- COMMAND_LEFT: 91, // COMMAND
- COMMAND_RIGHT: 93,
- CONTROL: 17,
- DELETE: 46,
- DOWN: 40,
- END: 35,
- ENTER: 13,
- ESCAPE: 27,
- HOME: 36,
- INSERT: 45,
- LEFT: 37,
- MENU: 93, // COMMAND_RIGHT
- NUMPAD_ADD: 107,
- NUMPAD_DECIMAL: 110,
- NUMPAD_DIVIDE: 111,
- NUMPAD_ENTER: 108,
- NUMPAD_MULTIPLY: 106,
- NUMPAD_SUBTRACT: 109,
- PAGE_DOWN: 34,
- PAGE_UP: 33,
- PERIOD: 190,
- RIGHT: 39,
- SHIFT: 16,
- SPACE: 32,
- TAB: 9,
- UP: 38,
- WINDOWS: 91 // COMMAND
- }
-});
-
-// plugins
-$.fn.extend({
- _focus: $.fn.focus,
- focus: function( delay, fn ) {
- return typeof delay === "number" ?
- this.each(function() {
- var elem = this;
- setTimeout(function() {
- $( elem ).focus();
- if ( fn ) {
- fn.call( elem );
- }
- }, delay );
- }) :
- this._focus.apply( this, arguments );
- },
-
- scrollParent: function() {
- var scrollParent;
- if (($.browser.msie && (/(static|relative)/).test(this.css('position'))) || (/absolute/).test(this.css('position'))) {
- scrollParent = this.parents().filter(function() {
- return (/(relative|absolute|fixed)/).test($.curCSS(this,'position',1)) && (/(auto|scroll)/).test($.curCSS(this,'overflow',1)+$.curCSS(this,'overflow-y',1)+$.curCSS(this,'overflow-x',1));
- }).eq(0);
- } else {
- scrollParent = this.parents().filter(function() {
- return (/(auto|scroll)/).test($.curCSS(this,'overflow',1)+$.curCSS(this,'overflow-y',1)+$.curCSS(this,'overflow-x',1));
- }).eq(0);
- }
-
- return (/fixed/).test(this.css('position')) || !scrollParent.length ? $(document) : scrollParent;
- },
-
- zIndex: function( zIndex ) {
- if ( zIndex !== undefined ) {
- return this.css( "zIndex", zIndex );
- }
-
- if ( this.length ) {
- var elem = $( this[ 0 ] ), position, value;
- while ( elem.length && elem[ 0 ] !== document ) {
- // Ignore z-index if position is set to a value where z-index is ignored by the browser
- // This makes behavior of this function consistent across browsers
- // WebKit always returns auto if the element is positioned
- position = elem.css( "position" );
- if ( position === "absolute" || position === "relative" || position === "fixed" ) {
- // IE returns 0 when zIndex is not specified
- // other browsers return a string
- // we ignore the case of nested elements with an explicit value of 0
- //
- value = parseInt( elem.css( "zIndex" ), 10 );
- if ( !isNaN( value ) && value !== 0 ) {
- return value;
- }
- }
- elem = elem.parent();
- }
- }
-
- return 0;
- },
-
- disableSelection: function() {
- return this.bind( ( $.support.selectstart ? "selectstart" : "mousedown" ) +
- ".ui-disableSelection", function( event ) {
- event.preventDefault();
- });
- },
-
- enableSelection: function() {
- return this.unbind( ".ui-disableSelection" );
- }
-});
-
-$.each( [ "Width", "Height" ], function( i, name ) {
- var side = name === "Width" ? [ "Left", "Right" ] : [ "Top", "Bottom" ],
- type = name.toLowerCase(),
- orig = {
- innerWidth: $.fn.innerWidth,
- innerHeight: $.fn.innerHeight,
- outerWidth: $.fn.outerWidth,
- outerHeight: $.fn.outerHeight
- };
-
- function reduce( elem, size, border, margin ) {
- $.each( side, function() {
- size -= parseFloat( $.curCSS( elem, "padding" + this, true) ) || 0;
- if ( border ) {
- size -= parseFloat( $.curCSS( elem, "border" + this + "Width", true) ) || 0;
- }
- if ( margin ) {
- size -= parseFloat( $.curCSS( elem, "margin" + this, true) ) || 0;
- }
- });
- return size;
- }
-
- $.fn[ "inner" + name ] = function( size ) {
- if ( size === undefined ) {
- return orig[ "inner" + name ].call( this );
- }
-
- return this.each(function() {
- $( this ).css( type, reduce( this, size ) + "px" );
- });
- };
-
- $.fn[ "outer" + name] = function( size, margin ) {
- if ( typeof size !== "number" ) {
- return orig[ "outer" + name ].call( this, size );
- }
-
- return this.each(function() {
- $( this).css( type, reduce( this, size, true, margin ) + "px" );
- });
- };
-});
-
-// selectors
-function focusable( element, isTabIndexNotNaN ) {
- var nodeName = element.nodeName.toLowerCase();
- if ( "area" === nodeName ) {
- var map = element.parentNode,
- mapName = map.name,
- img;
- if ( !element.href || !mapName || map.nodeName.toLowerCase() !== "map" ) {
- return false;
- }
- img = $( "img[usemap=#" + mapName + "]" )[0];
- return !!img && visible( img );
- }
- return ( /input|select|textarea|button|object/.test( nodeName )
- ? !element.disabled
- : "a" == nodeName
- ? element.href || isTabIndexNotNaN
- : isTabIndexNotNaN)
- // the element and all of its ancestors must be visible
- && visible( element );
-}
-
-function visible( element ) {
- return !$( element ).parents().andSelf().filter(function() {
- return $.curCSS( this, "visibility" ) === "hidden" ||
- $.expr.filters.hidden( this );
- }).length;
-}
-
-$.extend( $.expr[ ":" ], {
- data: function( elem, i, match ) {
- return !!$.data( elem, match[ 3 ] );
- },
-
- focusable: function( element ) {
- return focusable( element, !isNaN( $.attr( element, "tabindex" ) ) );
- },
-
- tabbable: function( element ) {
- var tabIndex = $.attr( element, "tabindex" ),
- isTabIndexNaN = isNaN( tabIndex );
- return ( isTabIndexNaN || tabIndex >= 0 ) && focusable( element, !isTabIndexNaN );
- }
-});
-
-// support
-$(function() {
- var body = document.body,
- div = body.appendChild( div = document.createElement( "div" ) );
-
- $.extend( div.style, {
- minHeight: "100px",
- height: "auto",
- padding: 0,
- borderWidth: 0
- });
-
- $.support.minHeight = div.offsetHeight === 100;
- $.support.selectstart = "onselectstart" in div;
-
- // set display to none to avoid a layout bug in IE
- // http://dev.jquery.com/ticket/4014
- body.removeChild( div ).style.display = "none";
-});
-
-
-
-
-
-// deprecated
-$.extend( $.ui, {
- // $.ui.plugin is deprecated. Use the proxy pattern instead.
- plugin: {
- add: function( module, option, set ) {
- var proto = $.ui[ module ].prototype;
- for ( var i in set ) {
- proto.plugins[ i ] = proto.plugins[ i ] || [];
- proto.plugins[ i ].push( [ option, set[ i ] ] );
- }
- },
- call: function( instance, name, args ) {
- var set = instance.plugins[ name ];
- if ( !set || !instance.element[ 0 ].parentNode ) {
- return;
- }
-
- for ( var i = 0; i < set.length; i++ ) {
- if ( instance.options[ set[ i ][ 0 ] ] ) {
- set[ i ][ 1 ].apply( instance.element, args );
- }
- }
- }
- },
-
- // will be deprecated when we switch to jQuery 1.4 - use jQuery.contains()
- contains: function( a, b ) {
- return document.compareDocumentPosition ?
- a.compareDocumentPosition( b ) & 16 :
- a !== b && a.contains( b );
- },
-
- // only used by resizable
- hasScroll: function( el, a ) {
-
- //If overflow is hidden, the element might have extra content, but the user wants to hide it
- if ( $( el ).css( "overflow" ) === "hidden") {
- return false;
- }
-
- var scroll = ( a && a === "left" ) ? "scrollLeft" : "scrollTop",
- has = false;
-
- if ( el[ scroll ] > 0 ) {
- return true;
- }
-
- // TODO: determine which cases actually cause this to happen
- // if the element doesn't have the scroll set, see if it's possible to
- // set the scroll
- el[ scroll ] = 1;
- has = ( el[ scroll ] > 0 );
- el[ scroll ] = 0;
- return has;
- },
-
- // these are odd functions, fix the API or move into individual plugins
- isOverAxis: function( x, reference, size ) {
- //Determines when x coordinate is over "b" element axis
- return ( x > reference ) && ( x < ( reference + size ) );
- },
- isOver: function( y, x, top, left, height, width ) {
- //Determines when x, y coordinates is over "b" element
- return $.ui.isOverAxis( y, top, height ) && $.ui.isOverAxis( x, left, width );
- }
-});
-
-})( jQuery );
-/*!
- * jQuery UI Widget 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Widget
- */
-(function( $, undefined ) {
-
-// jQuery 1.4+
-if ( $.cleanData ) {
- var _cleanData = $.cleanData;
- $.cleanData = function( elems ) {
- for ( var i = 0, elem; (elem = elems[i]) != null; i++ ) {
- $( elem ).triggerHandler( "remove" );
- }
- _cleanData( elems );
- };
-} else {
- var _remove = $.fn.remove;
- $.fn.remove = function( selector, keepData ) {
- return this.each(function() {
- if ( !keepData ) {
- if ( !selector || $.filter( selector, [ this ] ).length ) {
- $( "*", this ).add( [ this ] ).each(function() {
- $( this ).triggerHandler( "remove" );
- });
- }
- }
- return _remove.call( $(this), selector, keepData );
- });
- };
-}
-
-$.widget = function( name, base, prototype ) {
- var namespace = name.split( "." )[ 0 ],
- fullName;
- name = name.split( "." )[ 1 ];
- fullName = namespace + "-" + name;
-
- if ( !prototype ) {
- prototype = base;
- base = $.Widget;
- }
-
- // create selector for plugin
- $.expr[ ":" ][ fullName ] = function( elem ) {
- return !!$.data( elem, name );
- };
-
- $[ namespace ] = $[ namespace ] || {};
- $[ namespace ][ name ] = function( options, element ) {
- // allow instantiation without initializing for simple inheritance
- if ( arguments.length ) {
- this._createWidget( options, element );
- }
- };
-
- var basePrototype = new base();
- // we need to make the options hash a property directly on the new instance
- // otherwise we'll modify the options hash on the prototype that we're
- // inheriting from
-// $.each( basePrototype, function( key, val ) {
-// if ( $.isPlainObject(val) ) {
-// basePrototype[ key ] = $.extend( {}, val );
-// }
-// });
- basePrototype.options = $.extend( true, {}, basePrototype.options );
- $[ namespace ][ name ].prototype = $.extend( true, basePrototype, {
- namespace: namespace,
- widgetName: name,
- widgetEventPrefix: $[ namespace ][ name ].prototype.widgetEventPrefix || name,
- widgetBaseClass: fullName
- }, prototype );
-
- $.widget.bridge( name, $[ namespace ][ name ] );
-};
-
-$.widget.bridge = function( name, object ) {
- $.fn[ name ] = function( options ) {
- var isMethodCall = typeof options === "string",
- args = Array.prototype.slice.call( arguments, 1 ),
- returnValue = this;
-
- // allow multiple hashes to be passed on init
- options = !isMethodCall && args.length ?
- $.extend.apply( null, [ true, options ].concat(args) ) :
- options;
-
- // prevent calls to internal methods
- if ( isMethodCall && options.charAt( 0 ) === "_" ) {
- return returnValue;
- }
-
- if ( isMethodCall ) {
- this.each(function() {
- var instance = $.data( this, name ),
- methodValue = instance && $.isFunction( instance[options] ) ?
- instance[ options ].apply( instance, args ) :
- instance;
- // TODO: add this back in 1.9 and use $.error() (see #5972)
-// if ( !instance ) {
-// throw "cannot call methods on " + name + " prior to initialization; " +
-// "attempted to call method '" + options + "'";
-// }
-// if ( !$.isFunction( instance[options] ) ) {
-// throw "no such method '" + options + "' for " + name + " widget instance";
-// }
-// var methodValue = instance[ options ].apply( instance, args );
- if ( methodValue !== instance && methodValue !== undefined ) {
- returnValue = methodValue;
- return false;
- }
- });
- } else {
- this.each(function() {
- var instance = $.data( this, name );
- if ( instance ) {
- instance.option( options || {} )._init();
- } else {
- $.data( this, name, new object( options, this ) );
- }
- });
- }
-
- return returnValue;
- };
-};
-
-$.Widget = function( options, element ) {
- // allow instantiation without initializing for simple inheritance
- if ( arguments.length ) {
- this._createWidget( options, element );
- }
-};
-
-$.Widget.prototype = {
- widgetName: "widget",
- widgetEventPrefix: "",
- options: {
- disabled: false
- },
- _createWidget: function( options, element ) {
- // $.widget.bridge stores the plugin instance, but we do it anyway
- // so that it's stored even before the _create function runs
- $.data( element, this.widgetName, this );
- this.element = $( element );
- this.options = $.extend( true, {},
- this.options,
- this._getCreateOptions(),
- options );
-
- var self = this;
- this.element.bind( "remove." + this.widgetName, function() {
- self.destroy();
- });
-
- this._create();
- this._trigger( "create" );
- this._init();
- },
- _getCreateOptions: function() {
- return $.metadata && $.metadata.get( this.element[0] )[ this.widgetName ];
- },
- _create: function() {},
- _init: function() {},
-
- destroy: function() {
- this.element
- .unbind( "." + this.widgetName )
- .removeData( this.widgetName );
- this.widget()
- .unbind( "." + this.widgetName )
- .removeAttr( "aria-disabled" )
- .removeClass(
- this.widgetBaseClass + "-disabled " +
- "ui-state-disabled" );
- },
-
- widget: function() {
- return this.element;
- },
-
- option: function( key, value ) {
- var options = key;
-
- if ( arguments.length === 0 ) {
- // don't return a reference to the internal hash
- return $.extend( {}, this.options );
- }
-
- if (typeof key === "string" ) {
- if ( value === undefined ) {
- return this.options[ key ];
- }
- options = {};
- options[ key ] = value;
- }
-
- this._setOptions( options );
-
- return this;
- },
- _setOptions: function( options ) {
- var self = this;
- $.each( options, function( key, value ) {
- self._setOption( key, value );
- });
-
- return this;
- },
- _setOption: function( key, value ) {
- this.options[ key ] = value;
-
- if ( key === "disabled" ) {
- this.widget()
- [ value ? "addClass" : "removeClass"](
- this.widgetBaseClass + "-disabled" + " " +
- "ui-state-disabled" )
- .attr( "aria-disabled", value );
- }
-
- return this;
- },
-
- enable: function() {
- return this._setOption( "disabled", false );
- },
- disable: function() {
- return this._setOption( "disabled", true );
- },
-
- _trigger: function( type, event, data ) {
- var callback = this.options[ type ];
-
- event = $.Event( event );
- event.type = ( type === this.widgetEventPrefix ?
- type :
- this.widgetEventPrefix + type ).toLowerCase();
- data = data || {};
-
- // copy original event properties over to the new event
- // this would happen if we could call $.event.fix instead of $.Event
- // but we don't have a way to force an event to be fixed multiple times
- if ( event.originalEvent ) {
- for ( var i = $.event.props.length, prop; i; ) {
- prop = $.event.props[ --i ];
- event[ prop ] = event.originalEvent[ prop ];
- }
- }
-
- this.element.trigger( event, data );
-
- return !( $.isFunction(callback) &&
- callback.call( this.element[0], event, data ) === false ||
- event.isDefaultPrevented() );
- }
-};
-
-})( jQuery );
-/*!
- * jQuery UI Mouse 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Mouse
- *
- * Depends:
- * jquery.ui.widget.js
- */
-(function( $, undefined ) {
-
-var mouseHandled = false;
-$(document).mousedown(function(e) {
- mouseHandled = false;
-});
-
-$.widget("ui.mouse", {
- options: {
- cancel: ':input,option',
- distance: 1,
- delay: 0
- },
- _mouseInit: function() {
- var self = this;
-
- this.element
- .bind('mousedown.'+this.widgetName, function(event) {
- return self._mouseDown(event);
- })
- .bind('click.'+this.widgetName, function(event) {
- if (true === $.data(event.target, self.widgetName + '.preventClickEvent')) {
- $.removeData(event.target, self.widgetName + '.preventClickEvent');
- event.stopImmediatePropagation();
- return false;
- }
- });
-
- this.started = false;
- },
-
- // TODO: make sure destroying one instance of mouse doesn't mess with
- // other instances of mouse
- _mouseDestroy: function() {
- this.element.unbind('.'+this.widgetName);
- },
-
- _mouseDown: function(event) {
- // don't let more than one widget handle mouseStart
- if(mouseHandled) {return};
-
- // we may have missed mouseup (out of window)
- (this._mouseStarted && this._mouseUp(event));
-
- this._mouseDownEvent = event;
-
- var self = this,
- btnIsLeft = (event.which == 1),
- elIsCancel = (typeof this.options.cancel == "string" ? $(event.target).closest(this.options.cancel).length : false);
- if (!btnIsLeft || elIsCancel || !this._mouseCapture(event)) {
- return true;
- }
-
- this.mouseDelayMet = !this.options.delay;
- if (!this.mouseDelayMet) {
- this._mouseDelayTimer = setTimeout(function() {
- self.mouseDelayMet = true;
- }, this.options.delay);
- }
-
- if (this._mouseDistanceMet(event) && this._mouseDelayMet(event)) {
- this._mouseStarted = (this._mouseStart(event) !== false);
- if (!this._mouseStarted) {
- event.preventDefault();
- return true;
- }
- }
-
- // Click event may never have fired (Gecko & Opera)
- if (true === $.data(event.target, this.widgetName + '.preventClickEvent')) {
- $.removeData(event.target, this.widgetName + '.preventClickEvent');
- }
-
- // these delegates are required to keep context
- this._mouseMoveDelegate = function(event) {
- return self._mouseMove(event);
- };
- this._mouseUpDelegate = function(event) {
- return self._mouseUp(event);
- };
- $(document)
- .bind('mousemove.'+this.widgetName, this._mouseMoveDelegate)
- .bind('mouseup.'+this.widgetName, this._mouseUpDelegate);
-
- event.preventDefault();
-
- mouseHandled = true;
- return true;
- },
-
- _mouseMove: function(event) {
- // IE mouseup check - mouseup happened when mouse was out of window
- if ($.browser.msie && !(document.documentMode >= 9) && !event.button) {
- return this._mouseUp(event);
- }
-
- if (this._mouseStarted) {
- this._mouseDrag(event);
- return event.preventDefault();
- }
-
- if (this._mouseDistanceMet(event) && this._mouseDelayMet(event)) {
- this._mouseStarted =
- (this._mouseStart(this._mouseDownEvent, event) !== false);
- (this._mouseStarted ? this._mouseDrag(event) : this._mouseUp(event));
- }
-
- return !this._mouseStarted;
- },
-
- _mouseUp: function(event) {
- $(document)
- .unbind('mousemove.'+this.widgetName, this._mouseMoveDelegate)
- .unbind('mouseup.'+this.widgetName, this._mouseUpDelegate);
-
- if (this._mouseStarted) {
- this._mouseStarted = false;
-
- if (event.target == this._mouseDownEvent.target) {
- $.data(event.target, this.widgetName + '.preventClickEvent', true);
- }
-
- this._mouseStop(event);
- }
-
- return false;
- },
-
- _mouseDistanceMet: function(event) {
- return (Math.max(
- Math.abs(this._mouseDownEvent.pageX - event.pageX),
- Math.abs(this._mouseDownEvent.pageY - event.pageY)
- ) >= this.options.distance
- );
- },
-
- _mouseDelayMet: function(event) {
- return this.mouseDelayMet;
- },
-
- // These are placeholder methods, to be overriden by extending plugin
- _mouseStart: function(event) {},
- _mouseDrag: function(event) {},
- _mouseStop: function(event) {},
- _mouseCapture: function(event) { return true; }
-});
-
-})(jQuery);
-/*
- * jQuery UI Draggable 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Draggables
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.mouse.js
- * jquery.ui.widget.js
- */
-(function( $, undefined ) {
-
-$.widget("ui.draggable", $.ui.mouse, {
- widgetEventPrefix: "drag",
- options: {
- addClasses: true,
- appendTo: "parent",
- axis: false,
- connectToSortable: false,
- containment: false,
- cursor: "auto",
- cursorAt: false,
- grid: false,
- handle: false,
- helper: "original",
- iframeFix: false,
- opacity: false,
- refreshPositions: false,
- revert: false,
- revertDuration: 500,
- scope: "default",
- scroll: true,
- scrollSensitivity: 20,
- scrollSpeed: 20,
- snap: false,
- snapMode: "both",
- snapTolerance: 20,
- stack: false,
- zIndex: false
- },
- _create: function() {
-
- if (this.options.helper == 'original' && !(/^(?:r|a|f)/).test(this.element.css("position")))
- this.element[0].style.position = 'relative';
-
- (this.options.addClasses && this.element.addClass("ui-draggable"));
- (this.options.disabled && this.element.addClass("ui-draggable-disabled"));
-
- this._mouseInit();
-
- },
-
- destroy: function() {
- if(!this.element.data('draggable')) return;
- this.element
- .removeData("draggable")
- .unbind(".draggable")
- .removeClass("ui-draggable"
- + " ui-draggable-dragging"
- + " ui-draggable-disabled");
- this._mouseDestroy();
-
- return this;
- },
-
- _mouseCapture: function(event) {
-
- var o = this.options;
-
- // among others, prevent a drag on a resizable-handle
- if (this.helper || o.disabled || $(event.target).is('.ui-resizable-handle'))
- return false;
-
- //Quit if we're not on a valid handle
- this.handle = this._getHandle(event);
- if (!this.handle)
- return false;
-
- $(o.iframeFix === true ? "iframe" : o.iframeFix).each(function() {
- $('')
- .css({
- width: this.offsetWidth+"px", height: this.offsetHeight+"px",
- position: "absolute", opacity: "0.001", zIndex: 1000
- })
- .css($(this).offset())
- .appendTo("body");
- });
-
- return true;
-
- },
-
- _mouseStart: function(event) {
-
- var o = this.options;
-
- //Create and append the visible helper
- this.helper = this._createHelper(event);
-
- //Cache the helper size
- this._cacheHelperProportions();
-
- //If ddmanager is used for droppables, set the global draggable
- if($.ui.ddmanager)
- $.ui.ddmanager.current = this;
-
- /*
- * - Position generation -
- * This block generates everything position related - it's the core of draggables.
- */
-
- //Cache the margins of the original element
- this._cacheMargins();
-
- //Store the helper's css position
- this.cssPosition = this.helper.css("position");
- this.scrollParent = this.helper.scrollParent();
-
- //The element's absolute position on the page minus margins
- this.offset = this.positionAbs = this.element.offset();
- this.offset = {
- top: this.offset.top - this.margins.top,
- left: this.offset.left - this.margins.left
- };
-
- $.extend(this.offset, {
- click: { //Where the click happened, relative to the element
- left: event.pageX - this.offset.left,
- top: event.pageY - this.offset.top
- },
- parent: this._getParentOffset(),
- relative: this._getRelativeOffset() //This is a relative to absolute position minus the actual position calculation - only used for relative positioned helper
- });
-
- //Generate the original position
- this.originalPosition = this.position = this._generatePosition(event);
- this.originalPageX = event.pageX;
- this.originalPageY = event.pageY;
-
- //Adjust the mouse offset relative to the helper if 'cursorAt' is supplied
- (o.cursorAt && this._adjustOffsetFromHelper(o.cursorAt));
-
- //Set a containment if given in the options
- if(o.containment)
- this._setContainment();
-
- //Trigger event + callbacks
- if(this._trigger("start", event) === false) {
- this._clear();
- return false;
- }
-
- //Recache the helper size
- this._cacheHelperProportions();
-
- //Prepare the droppable offsets
- if ($.ui.ddmanager && !o.dropBehaviour)
- $.ui.ddmanager.prepareOffsets(this, event);
-
- this.helper.addClass("ui-draggable-dragging");
- this._mouseDrag(event, true); //Execute the drag once - this causes the helper not to be visible before getting its correct position
-
- //If the ddmanager is used for droppables, inform the manager that dragging has started (see #5003)
- if ( $.ui.ddmanager ) $.ui.ddmanager.dragStart(this, event);
-
- return true;
- },
-
- _mouseDrag: function(event, noPropagation) {
-
- //Compute the helpers position
- this.position = this._generatePosition(event);
- this.positionAbs = this._convertPositionTo("absolute");
-
- //Call plugins and callbacks and use the resulting position if something is returned
- if (!noPropagation) {
- var ui = this._uiHash();
- if(this._trigger('drag', event, ui) === false) {
- this._mouseUp({});
- return false;
- }
- this.position = ui.position;
- }
-
- if(!this.options.axis || this.options.axis != "y") this.helper[0].style.left = this.position.left+'px';
- if(!this.options.axis || this.options.axis != "x") this.helper[0].style.top = this.position.top+'px';
- if($.ui.ddmanager) $.ui.ddmanager.drag(this, event);
-
- return false;
- },
-
- _mouseStop: function(event) {
-
- //If we are using droppables, inform the manager about the drop
- var dropped = false;
- if ($.ui.ddmanager && !this.options.dropBehaviour)
- dropped = $.ui.ddmanager.drop(this, event);
-
- //if a drop comes from outside (a sortable)
- if(this.dropped) {
- dropped = this.dropped;
- this.dropped = false;
- }
-
- //if the original element is removed, don't bother to continue if helper is set to "original"
- if((!this.element[0] || !this.element[0].parentNode) && this.options.helper == "original")
- return false;
-
- if((this.options.revert == "invalid" && !dropped) || (this.options.revert == "valid" && dropped) || this.options.revert === true || ($.isFunction(this.options.revert) && this.options.revert.call(this.element, dropped))) {
- var self = this;
- $(this.helper).animate(this.originalPosition, parseInt(this.options.revertDuration, 10), function() {
- if(self._trigger("stop", event) !== false) {
- self._clear();
- }
- });
- } else {
- if(this._trigger("stop", event) !== false) {
- this._clear();
- }
- }
-
- return false;
- },
-
- _mouseUp: function(event) {
- if (this.options.iframeFix === true) {
- $("div.ui-draggable-iframeFix").each(function() {
- this.parentNode.removeChild(this);
- }); //Remove frame helpers
- }
-
- //If the ddmanager is used for droppables, inform the manager that dragging has stopped (see #5003)
- if( $.ui.ddmanager ) $.ui.ddmanager.dragStop(this, event);
-
- return $.ui.mouse.prototype._mouseUp.call(this, event);
- },
-
- cancel: function() {
-
- if(this.helper.is(".ui-draggable-dragging")) {
- this._mouseUp({});
- } else {
- this._clear();
- }
-
- return this;
-
- },
-
- _getHandle: function(event) {
-
- var handle = !this.options.handle || !$(this.options.handle, this.element).length ? true : false;
- $(this.options.handle, this.element)
- .find("*")
- .andSelf()
- .each(function() {
- if(this == event.target) handle = true;
- });
-
- return handle;
-
- },
-
- _createHelper: function(event) {
-
- var o = this.options;
- var helper = $.isFunction(o.helper) ? $(o.helper.apply(this.element[0], [event])) : (o.helper == 'clone' ? this.element.clone().removeAttr('id') : this.element);
-
- if(!helper.parents('body').length)
- helper.appendTo((o.appendTo == 'parent' ? this.element[0].parentNode : o.appendTo));
-
- if(helper[0] != this.element[0] && !(/(fixed|absolute)/).test(helper.css("position")))
- helper.css("position", "absolute");
-
- return helper;
-
- },
-
- _adjustOffsetFromHelper: function(obj) {
- if (typeof obj == 'string') {
- obj = obj.split(' ');
- }
- if ($.isArray(obj)) {
- obj = {left: +obj[0], top: +obj[1] || 0};
- }
- if ('left' in obj) {
- this.offset.click.left = obj.left + this.margins.left;
- }
- if ('right' in obj) {
- this.offset.click.left = this.helperProportions.width - obj.right + this.margins.left;
- }
- if ('top' in obj) {
- this.offset.click.top = obj.top + this.margins.top;
- }
- if ('bottom' in obj) {
- this.offset.click.top = this.helperProportions.height - obj.bottom + this.margins.top;
- }
- },
-
- _getParentOffset: function() {
-
- //Get the offsetParent and cache its position
- this.offsetParent = this.helper.offsetParent();
- var po = this.offsetParent.offset();
-
- // This is a special case where we need to modify a offset calculated on start, since the following happened:
- // 1. The position of the helper is absolute, so it's position is calculated based on the next positioned parent
- // 2. The actual offset parent is a child of the scroll parent, and the scroll parent isn't the document, which means that
- // the scroll is included in the initial calculation of the offset of the parent, and never recalculated upon drag
- if(this.cssPosition == 'absolute' && this.scrollParent[0] != document && $.ui.contains(this.scrollParent[0], this.offsetParent[0])) {
- po.left += this.scrollParent.scrollLeft();
- po.top += this.scrollParent.scrollTop();
- }
-
- if((this.offsetParent[0] == document.body) //This needs to be actually done for all browsers, since pageX/pageY includes this information
- || (this.offsetParent[0].tagName && this.offsetParent[0].tagName.toLowerCase() == 'html' && $.browser.msie)) //Ugly IE fix
- po = { top: 0, left: 0 };
-
- return {
- top: po.top + (parseInt(this.offsetParent.css("borderTopWidth"),10) || 0),
- left: po.left + (parseInt(this.offsetParent.css("borderLeftWidth"),10) || 0)
- };
-
- },
-
- _getRelativeOffset: function() {
-
- if(this.cssPosition == "relative") {
- var p = this.element.position();
- return {
- top: p.top - (parseInt(this.helper.css("top"),10) || 0) + this.scrollParent.scrollTop(),
- left: p.left - (parseInt(this.helper.css("left"),10) || 0) + this.scrollParent.scrollLeft()
- };
- } else {
- return { top: 0, left: 0 };
- }
-
- },
-
- _cacheMargins: function() {
- this.margins = {
- left: (parseInt(this.element.css("marginLeft"),10) || 0),
- top: (parseInt(this.element.css("marginTop"),10) || 0),
- right: (parseInt(this.element.css("marginRight"),10) || 0),
- bottom: (parseInt(this.element.css("marginBottom"),10) || 0)
- };
- },
-
- _cacheHelperProportions: function() {
- this.helperProportions = {
- width: this.helper.outerWidth(),
- height: this.helper.outerHeight()
- };
- },
-
- _setContainment: function() {
-
- var o = this.options;
- if(o.containment == 'parent') o.containment = this.helper[0].parentNode;
- if(o.containment == 'document' || o.containment == 'window') this.containment = [
- o.containment == 'document' ? 0 : $(window).scrollLeft() - this.offset.relative.left - this.offset.parent.left,
- o.containment == 'document' ? 0 : $(window).scrollTop() - this.offset.relative.top - this.offset.parent.top,
- (o.containment == 'document' ? 0 : $(window).scrollLeft()) + $(o.containment == 'document' ? document : window).width() - this.helperProportions.width - this.margins.left,
- (o.containment == 'document' ? 0 : $(window).scrollTop()) + ($(o.containment == 'document' ? document : window).height() || document.body.parentNode.scrollHeight) - this.helperProportions.height - this.margins.top
- ];
-
- if(!(/^(document|window|parent)$/).test(o.containment) && o.containment.constructor != Array) {
- var c = $(o.containment);
- var ce = c[0]; if(!ce) return;
- var co = c.offset();
- var over = ($(ce).css("overflow") != 'hidden');
-
- this.containment = [
- (parseInt($(ce).css("borderLeftWidth"),10) || 0) + (parseInt($(ce).css("paddingLeft"),10) || 0),
- (parseInt($(ce).css("borderTopWidth"),10) || 0) + (parseInt($(ce).css("paddingTop"),10) || 0),
- (over ? Math.max(ce.scrollWidth,ce.offsetWidth) : ce.offsetWidth) - (parseInt($(ce).css("borderLeftWidth"),10) || 0) - (parseInt($(ce).css("paddingRight"),10) || 0) - this.helperProportions.width - this.margins.left - this.margins.right,
- (over ? Math.max(ce.scrollHeight,ce.offsetHeight) : ce.offsetHeight) - (parseInt($(ce).css("borderTopWidth"),10) || 0) - (parseInt($(ce).css("paddingBottom"),10) || 0) - this.helperProportions.height - this.margins.top - this.margins.bottom
- ];
- this.relative_container = c;
-
- } else if(o.containment.constructor == Array) {
- this.containment = o.containment;
- }
-
- },
-
- _convertPositionTo: function(d, pos) {
-
- if(!pos) pos = this.position;
- var mod = d == "absolute" ? 1 : -1;
- var o = this.options, scroll = this.cssPosition == 'absolute' && !(this.scrollParent[0] != document && $.ui.contains(this.scrollParent[0], this.offsetParent[0])) ? this.offsetParent : this.scrollParent, scrollIsRootNode = (/(html|body)/i).test(scroll[0].tagName);
-
- return {
- top: (
- pos.top // The absolute mouse position
- + this.offset.relative.top * mod // Only for relative positioned nodes: Relative offset from element to offset parent
- + this.offset.parent.top * mod // The offsetParent's offset without borders (offset + border)
- - ($.browser.safari && $.browser.version < 526 && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollTop() : ( scrollIsRootNode ? 0 : scroll.scrollTop() ) ) * mod)
- ),
- left: (
- pos.left // The absolute mouse position
- + this.offset.relative.left * mod // Only for relative positioned nodes: Relative offset from element to offset parent
- + this.offset.parent.left * mod // The offsetParent's offset without borders (offset + border)
- - ($.browser.safari && $.browser.version < 526 && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollLeft() : scrollIsRootNode ? 0 : scroll.scrollLeft() ) * mod)
- )
- };
-
- },
-
- _generatePosition: function(event) {
-
- var o = this.options, scroll = this.cssPosition == 'absolute' && !(this.scrollParent[0] != document && $.ui.contains(this.scrollParent[0], this.offsetParent[0])) ? this.offsetParent : this.scrollParent, scrollIsRootNode = (/(html|body)/i).test(scroll[0].tagName);
- var pageX = event.pageX;
- var pageY = event.pageY;
-
- /*
- * - Position constraining -
- * Constrain the position to a mix of grid, containment.
- */
-
- if(this.originalPosition) { //If we are not dragging yet, we won't check for options
- var containment;
- if(this.containment) {
- if (this.relative_container){
- var co = this.relative_container.offset();
- containment = [ this.containment[0] + co.left,
- this.containment[1] + co.top,
- this.containment[2] + co.left,
- this.containment[3] + co.top ];
- }
- else {
- containment = this.containment;
- }
-
- if(event.pageX - this.offset.click.left < containment[0]) pageX = containment[0] + this.offset.click.left;
- if(event.pageY - this.offset.click.top < containment[1]) pageY = containment[1] + this.offset.click.top;
- if(event.pageX - this.offset.click.left > containment[2]) pageX = containment[2] + this.offset.click.left;
- if(event.pageY - this.offset.click.top > containment[3]) pageY = containment[3] + this.offset.click.top;
- }
-
- if(o.grid) {
- //Check for grid elements set to 0 to prevent divide by 0 error causing invalid argument errors in IE (see ticket #6950)
- var top = o.grid[1] ? this.originalPageY + Math.round((pageY - this.originalPageY) / o.grid[1]) * o.grid[1] : this.originalPageY;
- pageY = containment ? (!(top - this.offset.click.top < containment[1] || top - this.offset.click.top > containment[3]) ? top : (!(top - this.offset.click.top < containment[1]) ? top - o.grid[1] : top + o.grid[1])) : top;
-
- var left = o.grid[0] ? this.originalPageX + Math.round((pageX - this.originalPageX) / o.grid[0]) * o.grid[0] : this.originalPageX;
- pageX = containment ? (!(left - this.offset.click.left < containment[0] || left - this.offset.click.left > containment[2]) ? left : (!(left - this.offset.click.left < containment[0]) ? left - o.grid[0] : left + o.grid[0])) : left;
- }
-
- }
-
- return {
- top: (
- pageY // The absolute mouse position
- - this.offset.click.top // Click offset (relative to the element)
- - this.offset.relative.top // Only for relative positioned nodes: Relative offset from element to offset parent
- - this.offset.parent.top // The offsetParent's offset without borders (offset + border)
- + ($.browser.safari && $.browser.version < 526 && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollTop() : ( scrollIsRootNode ? 0 : scroll.scrollTop() ) ))
- ),
- left: (
- pageX // The absolute mouse position
- - this.offset.click.left // Click offset (relative to the element)
- - this.offset.relative.left // Only for relative positioned nodes: Relative offset from element to offset parent
- - this.offset.parent.left // The offsetParent's offset without borders (offset + border)
- + ($.browser.safari && $.browser.version < 526 && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollLeft() : scrollIsRootNode ? 0 : scroll.scrollLeft() ))
- )
- };
-
- },
-
- _clear: function() {
- this.helper.removeClass("ui-draggable-dragging");
- if(this.helper[0] != this.element[0] && !this.cancelHelperRemoval) this.helper.remove();
- //if($.ui.ddmanager) $.ui.ddmanager.current = null;
- this.helper = null;
- this.cancelHelperRemoval = false;
- },
-
- // From now on bulk stuff - mainly helpers
-
- _trigger: function(type, event, ui) {
- ui = ui || this._uiHash();
- $.ui.plugin.call(this, type, [event, ui]);
- if(type == "drag") this.positionAbs = this._convertPositionTo("absolute"); //The absolute position has to be recalculated after plugins
- return $.Widget.prototype._trigger.call(this, type, event, ui);
- },
-
- plugins: {},
-
- _uiHash: function(event) {
- return {
- helper: this.helper,
- position: this.position,
- originalPosition: this.originalPosition,
- offset: this.positionAbs
- };
- }
-
-});
-
-$.extend($.ui.draggable, {
- version: "1.8.14"
-});
-
-$.ui.plugin.add("draggable", "connectToSortable", {
- start: function(event, ui) {
-
- var inst = $(this).data("draggable"), o = inst.options,
- uiSortable = $.extend({}, ui, { item: inst.element });
- inst.sortables = [];
- $(o.connectToSortable).each(function() {
- var sortable = $.data(this, 'sortable');
- if (sortable && !sortable.options.disabled) {
- inst.sortables.push({
- instance: sortable,
- shouldRevert: sortable.options.revert
- });
- sortable.refreshPositions(); // Call the sortable's refreshPositions at drag start to refresh the containerCache since the sortable container cache is used in drag and needs to be up to date (this will ensure it's initialised as well as being kept in step with any changes that might have happened on the page).
- sortable._trigger("activate", event, uiSortable);
- }
- });
-
- },
- stop: function(event, ui) {
-
- //If we are still over the sortable, we fake the stop event of the sortable, but also remove helper
- var inst = $(this).data("draggable"),
- uiSortable = $.extend({}, ui, { item: inst.element });
-
- $.each(inst.sortables, function() {
- if(this.instance.isOver) {
-
- this.instance.isOver = 0;
-
- inst.cancelHelperRemoval = true; //Don't remove the helper in the draggable instance
- this.instance.cancelHelperRemoval = false; //Remove it in the sortable instance (so sortable plugins like revert still work)
-
- //The sortable revert is supported, and we have to set a temporary dropped variable on the draggable to support revert: 'valid/invalid'
- if(this.shouldRevert) this.instance.options.revert = true;
-
- //Trigger the stop of the sortable
- this.instance._mouseStop(event);
-
- this.instance.options.helper = this.instance.options._helper;
-
- //If the helper has been the original item, restore properties in the sortable
- if(inst.options.helper == 'original')
- this.instance.currentItem.css({ top: 'auto', left: 'auto' });
-
- } else {
- this.instance.cancelHelperRemoval = false; //Remove the helper in the sortable instance
- this.instance._trigger("deactivate", event, uiSortable);
- }
-
- });
-
- },
- drag: function(event, ui) {
-
- var inst = $(this).data("draggable"), self = this;
-
- var checkPos = function(o) {
- var dyClick = this.offset.click.top, dxClick = this.offset.click.left;
- var helperTop = this.positionAbs.top, helperLeft = this.positionAbs.left;
- var itemHeight = o.height, itemWidth = o.width;
- var itemTop = o.top, itemLeft = o.left;
-
- return $.ui.isOver(helperTop + dyClick, helperLeft + dxClick, itemTop, itemLeft, itemHeight, itemWidth);
- };
-
- $.each(inst.sortables, function(i) {
-
- //Copy over some variables to allow calling the sortable's native _intersectsWith
- this.instance.positionAbs = inst.positionAbs;
- this.instance.helperProportions = inst.helperProportions;
- this.instance.offset.click = inst.offset.click;
-
- if(this.instance._intersectsWith(this.instance.containerCache)) {
-
- //If it intersects, we use a little isOver variable and set it once, so our move-in stuff gets fired only once
- if(!this.instance.isOver) {
-
- this.instance.isOver = 1;
- //Now we fake the start of dragging for the sortable instance,
- //by cloning the list group item, appending it to the sortable and using it as inst.currentItem
- //We can then fire the start event of the sortable with our passed browser event, and our own helper (so it doesn't create a new one)
- this.instance.currentItem = $(self).clone().removeAttr('id').appendTo(this.instance.element).data("sortable-item", true);
- this.instance.options._helper = this.instance.options.helper; //Store helper option to later restore it
- this.instance.options.helper = function() { return ui.helper[0]; };
-
- event.target = this.instance.currentItem[0];
- this.instance._mouseCapture(event, true);
- this.instance._mouseStart(event, true, true);
-
- //Because the browser event is way off the new appended portlet, we modify a couple of variables to reflect the changes
- this.instance.offset.click.top = inst.offset.click.top;
- this.instance.offset.click.left = inst.offset.click.left;
- this.instance.offset.parent.left -= inst.offset.parent.left - this.instance.offset.parent.left;
- this.instance.offset.parent.top -= inst.offset.parent.top - this.instance.offset.parent.top;
-
- inst._trigger("toSortable", event);
- inst.dropped = this.instance.element; //draggable revert needs that
- //hack so receive/update callbacks work (mostly)
- inst.currentItem = inst.element;
- this.instance.fromOutside = inst;
-
- }
-
- //Provided we did all the previous steps, we can fire the drag event of the sortable on every draggable drag, when it intersects with the sortable
- if(this.instance.currentItem) this.instance._mouseDrag(event);
-
- } else {
-
- //If it doesn't intersect with the sortable, and it intersected before,
- //we fake the drag stop of the sortable, but make sure it doesn't remove the helper by using cancelHelperRemoval
- if(this.instance.isOver) {
-
- this.instance.isOver = 0;
- this.instance.cancelHelperRemoval = true;
-
- //Prevent reverting on this forced stop
- this.instance.options.revert = false;
-
- // The out event needs to be triggered independently
- this.instance._trigger('out', event, this.instance._uiHash(this.instance));
-
- this.instance._mouseStop(event, true);
- this.instance.options.helper = this.instance.options._helper;
-
- //Now we remove our currentItem, the list group clone again, and the placeholder, and animate the helper back to it's original size
- this.instance.currentItem.remove();
- if(this.instance.placeholder) this.instance.placeholder.remove();
-
- inst._trigger("fromSortable", event);
- inst.dropped = false; //draggable revert needs that
- }
-
- };
-
- });
-
- }
-});
-
-$.ui.plugin.add("draggable", "cursor", {
- start: function(event, ui) {
- var t = $('body'), o = $(this).data('draggable').options;
- if (t.css("cursor")) o._cursor = t.css("cursor");
- t.css("cursor", o.cursor);
- },
- stop: function(event, ui) {
- var o = $(this).data('draggable').options;
- if (o._cursor) $('body').css("cursor", o._cursor);
- }
-});
-
-$.ui.plugin.add("draggable", "opacity", {
- start: function(event, ui) {
- var t = $(ui.helper), o = $(this).data('draggable').options;
- if(t.css("opacity")) o._opacity = t.css("opacity");
- t.css('opacity', o.opacity);
- },
- stop: function(event, ui) {
- var o = $(this).data('draggable').options;
- if(o._opacity) $(ui.helper).css('opacity', o._opacity);
- }
-});
-
-$.ui.plugin.add("draggable", "scroll", {
- start: function(event, ui) {
- var i = $(this).data("draggable");
- if(i.scrollParent[0] != document && i.scrollParent[0].tagName != 'HTML') i.overflowOffset = i.scrollParent.offset();
- },
- drag: function(event, ui) {
-
- var i = $(this).data("draggable"), o = i.options, scrolled = false;
-
- if(i.scrollParent[0] != document && i.scrollParent[0].tagName != 'HTML') {
-
- if(!o.axis || o.axis != 'x') {
- if((i.overflowOffset.top + i.scrollParent[0].offsetHeight) - event.pageY < o.scrollSensitivity)
- i.scrollParent[0].scrollTop = scrolled = i.scrollParent[0].scrollTop + o.scrollSpeed;
- else if(event.pageY - i.overflowOffset.top < o.scrollSensitivity)
- i.scrollParent[0].scrollTop = scrolled = i.scrollParent[0].scrollTop - o.scrollSpeed;
- }
-
- if(!o.axis || o.axis != 'y') {
- if((i.overflowOffset.left + i.scrollParent[0].offsetWidth) - event.pageX < o.scrollSensitivity)
- i.scrollParent[0].scrollLeft = scrolled = i.scrollParent[0].scrollLeft + o.scrollSpeed;
- else if(event.pageX - i.overflowOffset.left < o.scrollSensitivity)
- i.scrollParent[0].scrollLeft = scrolled = i.scrollParent[0].scrollLeft - o.scrollSpeed;
- }
-
- } else {
-
- if(!o.axis || o.axis != 'x') {
- if(event.pageY - $(document).scrollTop() < o.scrollSensitivity)
- scrolled = $(document).scrollTop($(document).scrollTop() - o.scrollSpeed);
- else if($(window).height() - (event.pageY - $(document).scrollTop()) < o.scrollSensitivity)
- scrolled = $(document).scrollTop($(document).scrollTop() + o.scrollSpeed);
- }
-
- if(!o.axis || o.axis != 'y') {
- if(event.pageX - $(document).scrollLeft() < o.scrollSensitivity)
- scrolled = $(document).scrollLeft($(document).scrollLeft() - o.scrollSpeed);
- else if($(window).width() - (event.pageX - $(document).scrollLeft()) < o.scrollSensitivity)
- scrolled = $(document).scrollLeft($(document).scrollLeft() + o.scrollSpeed);
- }
-
- }
-
- if(scrolled !== false && $.ui.ddmanager && !o.dropBehaviour)
- $.ui.ddmanager.prepareOffsets(i, event);
-
- }
-});
-
-$.ui.plugin.add("draggable", "snap", {
- start: function(event, ui) {
-
- var i = $(this).data("draggable"), o = i.options;
- i.snapElements = [];
-
- $(o.snap.constructor != String ? ( o.snap.items || ':data(draggable)' ) : o.snap).each(function() {
- var $t = $(this); var $o = $t.offset();
- if(this != i.element[0]) i.snapElements.push({
- item: this,
- width: $t.outerWidth(), height: $t.outerHeight(),
- top: $o.top, left: $o.left
- });
- });
-
- },
- drag: function(event, ui) {
-
- var inst = $(this).data("draggable"), o = inst.options;
- var d = o.snapTolerance;
-
- var x1 = ui.offset.left, x2 = x1 + inst.helperProportions.width,
- y1 = ui.offset.top, y2 = y1 + inst.helperProportions.height;
-
- for (var i = inst.snapElements.length - 1; i >= 0; i--){
-
- var l = inst.snapElements[i].left, r = l + inst.snapElements[i].width,
- t = inst.snapElements[i].top, b = t + inst.snapElements[i].height;
-
- //Yes, I know, this is insane ;)
- if(!((l-d < x1 && x1 < r+d && t-d < y1 && y1 < b+d) || (l-d < x1 && x1 < r+d && t-d < y2 && y2 < b+d) || (l-d < x2 && x2 < r+d && t-d < y1 && y1 < b+d) || (l-d < x2 && x2 < r+d && t-d < y2 && y2 < b+d))) {
- if(inst.snapElements[i].snapping) (inst.options.snap.release && inst.options.snap.release.call(inst.element, event, $.extend(inst._uiHash(), { snapItem: inst.snapElements[i].item })));
- inst.snapElements[i].snapping = false;
- continue;
- }
-
- if(o.snapMode != 'inner') {
- var ts = Math.abs(t - y2) <= d;
- var bs = Math.abs(b - y1) <= d;
- var ls = Math.abs(l - x2) <= d;
- var rs = Math.abs(r - x1) <= d;
- if(ts) ui.position.top = inst._convertPositionTo("relative", { top: t - inst.helperProportions.height, left: 0 }).top - inst.margins.top;
- if(bs) ui.position.top = inst._convertPositionTo("relative", { top: b, left: 0 }).top - inst.margins.top;
- if(ls) ui.position.left = inst._convertPositionTo("relative", { top: 0, left: l - inst.helperProportions.width }).left - inst.margins.left;
- if(rs) ui.position.left = inst._convertPositionTo("relative", { top: 0, left: r }).left - inst.margins.left;
- }
-
- var first = (ts || bs || ls || rs);
-
- if(o.snapMode != 'outer') {
- var ts = Math.abs(t - y1) <= d;
- var bs = Math.abs(b - y2) <= d;
- var ls = Math.abs(l - x1) <= d;
- var rs = Math.abs(r - x2) <= d;
- if(ts) ui.position.top = inst._convertPositionTo("relative", { top: t, left: 0 }).top - inst.margins.top;
- if(bs) ui.position.top = inst._convertPositionTo("relative", { top: b - inst.helperProportions.height, left: 0 }).top - inst.margins.top;
- if(ls) ui.position.left = inst._convertPositionTo("relative", { top: 0, left: l }).left - inst.margins.left;
- if(rs) ui.position.left = inst._convertPositionTo("relative", { top: 0, left: r - inst.helperProportions.width }).left - inst.margins.left;
- }
-
- if(!inst.snapElements[i].snapping && (ts || bs || ls || rs || first))
- (inst.options.snap.snap && inst.options.snap.snap.call(inst.element, event, $.extend(inst._uiHash(), { snapItem: inst.snapElements[i].item })));
- inst.snapElements[i].snapping = (ts || bs || ls || rs || first);
-
- };
-
- }
-});
-
-$.ui.plugin.add("draggable", "stack", {
- start: function(event, ui) {
-
- var o = $(this).data("draggable").options;
-
- var group = $.makeArray($(o.stack)).sort(function(a,b) {
- return (parseInt($(a).css("zIndex"),10) || 0) - (parseInt($(b).css("zIndex"),10) || 0);
- });
- if (!group.length) { return; }
-
- var min = parseInt(group[0].style.zIndex) || 0;
- $(group).each(function(i) {
- this.style.zIndex = min + i;
- });
-
- this[0].style.zIndex = min + group.length;
-
- }
-});
-
-$.ui.plugin.add("draggable", "zIndex", {
- start: function(event, ui) {
- var t = $(ui.helper), o = $(this).data("draggable").options;
- if(t.css("zIndex")) o._zIndex = t.css("zIndex");
- t.css('zIndex', o.zIndex);
- },
- stop: function(event, ui) {
- var o = $(this).data("draggable").options;
- if(o._zIndex) $(ui.helper).css('zIndex', o._zIndex);
- }
-});
-
-})(jQuery);
-/*
- * jQuery UI Droppable 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Droppables
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.widget.js
- * jquery.ui.mouse.js
- * jquery.ui.draggable.js
- */
-(function( $, undefined ) {
-
-$.widget("ui.droppable", {
- widgetEventPrefix: "drop",
- options: {
- accept: '*',
- activeClass: false,
- addClasses: true,
- greedy: false,
- hoverClass: false,
- scope: 'default',
- tolerance: 'intersect'
- },
- _create: function() {
-
- var o = this.options, accept = o.accept;
- this.isover = 0; this.isout = 1;
-
- this.accept = $.isFunction(accept) ? accept : function(d) {
- return d.is(accept);
- };
-
- //Store the droppable's proportions
- this.proportions = { width: this.element[0].offsetWidth, height: this.element[0].offsetHeight };
-
- // Add the reference and positions to the manager
- $.ui.ddmanager.droppables[o.scope] = $.ui.ddmanager.droppables[o.scope] || [];
- $.ui.ddmanager.droppables[o.scope].push(this);
-
- (o.addClasses && this.element.addClass("ui-droppable"));
-
- },
-
- destroy: function() {
- var drop = $.ui.ddmanager.droppables[this.options.scope];
- for ( var i = 0; i < drop.length; i++ )
- if ( drop[i] == this )
- drop.splice(i, 1);
-
- this.element
- .removeClass("ui-droppable ui-droppable-disabled")
- .removeData("droppable")
- .unbind(".droppable");
-
- return this;
- },
-
- _setOption: function(key, value) {
-
- if(key == 'accept') {
- this.accept = $.isFunction(value) ? value : function(d) {
- return d.is(value);
- };
- }
- $.Widget.prototype._setOption.apply(this, arguments);
- },
-
- _activate: function(event) {
- var draggable = $.ui.ddmanager.current;
- if(this.options.activeClass) this.element.addClass(this.options.activeClass);
- (draggable && this._trigger('activate', event, this.ui(draggable)));
- },
-
- _deactivate: function(event) {
- var draggable = $.ui.ddmanager.current;
- if(this.options.activeClass) this.element.removeClass(this.options.activeClass);
- (draggable && this._trigger('deactivate', event, this.ui(draggable)));
- },
-
- _over: function(event) {
-
- var draggable = $.ui.ddmanager.current;
- if (!draggable || (draggable.currentItem || draggable.element)[0] == this.element[0]) return; // Bail if draggable and droppable are same element
-
- if (this.accept.call(this.element[0],(draggable.currentItem || draggable.element))) {
- if(this.options.hoverClass) this.element.addClass(this.options.hoverClass);
- this._trigger('over', event, this.ui(draggable));
- }
-
- },
-
- _out: function(event) {
-
- var draggable = $.ui.ddmanager.current;
- if (!draggable || (draggable.currentItem || draggable.element)[0] == this.element[0]) return; // Bail if draggable and droppable are same element
-
- if (this.accept.call(this.element[0],(draggable.currentItem || draggable.element))) {
- if(this.options.hoverClass) this.element.removeClass(this.options.hoverClass);
- this._trigger('out', event, this.ui(draggable));
- }
-
- },
-
- _drop: function(event,custom) {
-
- var draggable = custom || $.ui.ddmanager.current;
- if (!draggable || (draggable.currentItem || draggable.element)[0] == this.element[0]) return false; // Bail if draggable and droppable are same element
-
- var childrenIntersection = false;
- this.element.find(":data(droppable)").not(".ui-draggable-dragging").each(function() {
- var inst = $.data(this, 'droppable');
- if(
- inst.options.greedy
- && !inst.options.disabled
- && inst.options.scope == draggable.options.scope
- && inst.accept.call(inst.element[0], (draggable.currentItem || draggable.element))
- && $.ui.intersect(draggable, $.extend(inst, { offset: inst.element.offset() }), inst.options.tolerance)
- ) { childrenIntersection = true; return false; }
- });
- if(childrenIntersection) return false;
-
- if(this.accept.call(this.element[0],(draggable.currentItem || draggable.element))) {
- if(this.options.activeClass) this.element.removeClass(this.options.activeClass);
- if(this.options.hoverClass) this.element.removeClass(this.options.hoverClass);
- this._trigger('drop', event, this.ui(draggable));
- return this.element;
- }
-
- return false;
-
- },
-
- ui: function(c) {
- return {
- draggable: (c.currentItem || c.element),
- helper: c.helper,
- position: c.position,
- offset: c.positionAbs
- };
- }
-
-});
-
-$.extend($.ui.droppable, {
- version: "1.8.14"
-});
-
-$.ui.intersect = function(draggable, droppable, toleranceMode) {
-
- if (!droppable.offset) return false;
-
- var x1 = (draggable.positionAbs || draggable.position.absolute).left, x2 = x1 + draggable.helperProportions.width,
- y1 = (draggable.positionAbs || draggable.position.absolute).top, y2 = y1 + draggable.helperProportions.height;
- var l = droppable.offset.left, r = l + droppable.proportions.width,
- t = droppable.offset.top, b = t + droppable.proportions.height;
-
- switch (toleranceMode) {
- case 'fit':
- return (l <= x1 && x2 <= r
- && t <= y1 && y2 <= b);
- break;
- case 'intersect':
- return (l < x1 + (draggable.helperProportions.width / 2) // Right Half
- && x2 - (draggable.helperProportions.width / 2) < r // Left Half
- && t < y1 + (draggable.helperProportions.height / 2) // Bottom Half
- && y2 - (draggable.helperProportions.height / 2) < b ); // Top Half
- break;
- case 'pointer':
- var draggableLeft = ((draggable.positionAbs || draggable.position.absolute).left + (draggable.clickOffset || draggable.offset.click).left),
- draggableTop = ((draggable.positionAbs || draggable.position.absolute).top + (draggable.clickOffset || draggable.offset.click).top),
- isOver = $.ui.isOver(draggableTop, draggableLeft, t, l, droppable.proportions.height, droppable.proportions.width);
- return isOver;
- break;
- case 'touch':
- return (
- (y1 >= t && y1 <= b) || // Top edge touching
- (y2 >= t && y2 <= b) || // Bottom edge touching
- (y1 < t && y2 > b) // Surrounded vertically
- ) && (
- (x1 >= l && x1 <= r) || // Left edge touching
- (x2 >= l && x2 <= r) || // Right edge touching
- (x1 < l && x2 > r) // Surrounded horizontally
- );
- break;
- default:
- return false;
- break;
- }
-
-};
-
-/*
- This manager tracks offsets of draggables and droppables
-*/
-$.ui.ddmanager = {
- current: null,
- droppables: { 'default': [] },
- prepareOffsets: function(t, event) {
-
- var m = $.ui.ddmanager.droppables[t.options.scope] || [];
- var type = event ? event.type : null; // workaround for #2317
- var list = (t.currentItem || t.element).find(":data(droppable)").andSelf();
-
- droppablesLoop: for (var i = 0; i < m.length; i++) {
-
- if(m[i].options.disabled || (t && !m[i].accept.call(m[i].element[0],(t.currentItem || t.element)))) continue; //No disabled and non-accepted
- for (var j=0; j < list.length; j++) { if(list[j] == m[i].element[0]) { m[i].proportions.height = 0; continue droppablesLoop; } }; //Filter out elements in the current dragged item
- m[i].visible = m[i].element.css("display") != "none"; if(!m[i].visible) continue; //If the element is not visible, continue
-
- if(type == "mousedown") m[i]._activate.call(m[i], event); //Activate the droppable if used directly from draggables
-
- m[i].offset = m[i].element.offset();
- m[i].proportions = { width: m[i].element[0].offsetWidth, height: m[i].element[0].offsetHeight };
-
- }
-
- },
- drop: function(draggable, event) {
-
- var dropped = false;
- $.each($.ui.ddmanager.droppables[draggable.options.scope] || [], function() {
-
- if(!this.options) return;
- if (!this.options.disabled && this.visible && $.ui.intersect(draggable, this, this.options.tolerance))
- dropped = dropped || this._drop.call(this, event);
-
- if (!this.options.disabled && this.visible && this.accept.call(this.element[0],(draggable.currentItem || draggable.element))) {
- this.isout = 1; this.isover = 0;
- this._deactivate.call(this, event);
- }
-
- });
- return dropped;
-
- },
- dragStart: function( draggable, event ) {
- //Listen for scrolling so that if the dragging causes scrolling the position of the droppables can be recalculated (see #5003)
- draggable.element.parentsUntil( "body" ).bind( "scroll.droppable", function() {
- if( !draggable.options.refreshPositions ) $.ui.ddmanager.prepareOffsets( draggable, event );
- });
- },
- drag: function(draggable, event) {
-
- //If you have a highly dynamic page, you might try this option. It renders positions every time you move the mouse.
- if(draggable.options.refreshPositions) $.ui.ddmanager.prepareOffsets(draggable, event);
-
- //Run through all droppables and check their positions based on specific tolerance options
- $.each($.ui.ddmanager.droppables[draggable.options.scope] || [], function() {
-
- if(this.options.disabled || this.greedyChild || !this.visible) return;
- var intersects = $.ui.intersect(draggable, this, this.options.tolerance);
-
- var c = !intersects && this.isover == 1 ? 'isout' : (intersects && this.isover == 0 ? 'isover' : null);
- if(!c) return;
-
- var parentInstance;
- if (this.options.greedy) {
- var parent = this.element.parents(':data(droppable):eq(0)');
- if (parent.length) {
- parentInstance = $.data(parent[0], 'droppable');
- parentInstance.greedyChild = (c == 'isover' ? 1 : 0);
- }
- }
-
- // we just moved into a greedy child
- if (parentInstance && c == 'isover') {
- parentInstance['isover'] = 0;
- parentInstance['isout'] = 1;
- parentInstance._out.call(parentInstance, event);
- }
-
- this[c] = 1; this[c == 'isout' ? 'isover' : 'isout'] = 0;
- this[c == "isover" ? "_over" : "_out"].call(this, event);
-
- // we just moved out of a greedy child
- if (parentInstance && c == 'isout') {
- parentInstance['isout'] = 0;
- parentInstance['isover'] = 1;
- parentInstance._over.call(parentInstance, event);
- }
- });
-
- },
- dragStop: function( draggable, event ) {
- draggable.element.parentsUntil( "body" ).unbind( "scroll.droppable" );
- //Call prepareOffsets one final time since IE does not fire return scroll events when overflow was caused by drag (see #5003)
- if( !draggable.options.refreshPositions ) $.ui.ddmanager.prepareOffsets( draggable, event );
- }
-};
-
-})(jQuery);
-/*
- * jQuery UI Resizable 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Resizables
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.mouse.js
- * jquery.ui.widget.js
- */
-(function( $, undefined ) {
-
-$.widget("ui.resizable", $.ui.mouse, {
- widgetEventPrefix: "resize",
- options: {
- alsoResize: false,
- animate: false,
- animateDuration: "slow",
- animateEasing: "swing",
- aspectRatio: false,
- autoHide: false,
- containment: false,
- ghost: false,
- grid: false,
- handles: "e,s,se",
- helper: false,
- maxHeight: null,
- maxWidth: null,
- minHeight: 10,
- minWidth: 10,
- zIndex: 1000
- },
- _create: function() {
-
- var self = this, o = this.options;
- this.element.addClass("ui-resizable");
-
- $.extend(this, {
- _aspectRatio: !!(o.aspectRatio),
- aspectRatio: o.aspectRatio,
- originalElement: this.element,
- _proportionallyResizeElements: [],
- _helper: o.helper || o.ghost || o.animate ? o.helper || 'ui-resizable-helper' : null
- });
-
- //Wrap the element if it cannot hold child nodes
- if(this.element[0].nodeName.match(/canvas|textarea|input|select|button|img/i)) {
-
- //Opera fix for relative positioning
- if (/relative/.test(this.element.css('position')) && $.browser.opera)
- this.element.css({ position: 'relative', top: 'auto', left: 'auto' });
-
- //Create a wrapper element and set the wrapper to the new current internal element
- this.element.wrap(
- $('').css({
- position: this.element.css('position'),
- width: this.element.outerWidth(),
- height: this.element.outerHeight(),
- top: this.element.css('top'),
- left: this.element.css('left')
- })
- );
-
- //Overwrite the original this.element
- this.element = this.element.parent().data(
- "resizable", this.element.data('resizable')
- );
-
- this.elementIsWrapper = true;
-
- //Move margins to the wrapper
- this.element.css({ marginLeft: this.originalElement.css("marginLeft"), marginTop: this.originalElement.css("marginTop"), marginRight: this.originalElement.css("marginRight"), marginBottom: this.originalElement.css("marginBottom") });
- this.originalElement.css({ marginLeft: 0, marginTop: 0, marginRight: 0, marginBottom: 0});
-
- //Prevent Safari textarea resize
- this.originalResizeStyle = this.originalElement.css('resize');
- this.originalElement.css('resize', 'none');
-
- //Push the actual element to our proportionallyResize internal array
- this._proportionallyResizeElements.push(this.originalElement.css({ position: 'static', zoom: 1, display: 'block' }));
-
- // avoid IE jump (hard set the margin)
- this.originalElement.css({ margin: this.originalElement.css('margin') });
-
- // fix handlers offset
- this._proportionallyResize();
-
- }
-
- this.handles = o.handles || (!$('.ui-resizable-handle', this.element).length ? "e,s,se" : { n: '.ui-resizable-n', e: '.ui-resizable-e', s: '.ui-resizable-s', w: '.ui-resizable-w', se: '.ui-resizable-se', sw: '.ui-resizable-sw', ne: '.ui-resizable-ne', nw: '.ui-resizable-nw' });
- if(this.handles.constructor == String) {
-
- if(this.handles == 'all') this.handles = 'n,e,s,w,se,sw,ne,nw';
- var n = this.handles.split(","); this.handles = {};
-
- for(var i = 0; i < n.length; i++) {
-
- var handle = $.trim(n[i]), hname = 'ui-resizable-'+handle;
- var axis = $('');
-
- // increase zIndex of sw, se, ne, nw axis
- //TODO : this modifies original option
- if(/sw|se|ne|nw/.test(handle)) axis.css({ zIndex: ++o.zIndex });
-
- //TODO : What's going on here?
- if ('se' == handle) {
- axis.addClass('ui-icon ui-icon-gripsmall-diagonal-se');
- };
-
- //Insert into internal handles object and append to element
- this.handles[handle] = '.ui-resizable-'+handle;
- this.element.append(axis);
- }
-
- }
-
- this._renderAxis = function(target) {
-
- target = target || this.element;
-
- for(var i in this.handles) {
-
- if(this.handles[i].constructor == String)
- this.handles[i] = $(this.handles[i], this.element).show();
-
- //Apply pad to wrapper element, needed to fix axis position (textarea, inputs, scrolls)
- if (this.elementIsWrapper && this.originalElement[0].nodeName.match(/textarea|input|select|button/i)) {
-
- var axis = $(this.handles[i], this.element), padWrapper = 0;
-
- //Checking the correct pad and border
- padWrapper = /sw|ne|nw|se|n|s/.test(i) ? axis.outerHeight() : axis.outerWidth();
-
- //The padding type i have to apply...
- var padPos = [ 'padding',
- /ne|nw|n/.test(i) ? 'Top' :
- /se|sw|s/.test(i) ? 'Bottom' :
- /^e$/.test(i) ? 'Right' : 'Left' ].join("");
-
- target.css(padPos, padWrapper);
-
- this._proportionallyResize();
-
- }
-
- //TODO: What's that good for? There's not anything to be executed left
- if(!$(this.handles[i]).length)
- continue;
-
- }
- };
-
- //TODO: make renderAxis a prototype function
- this._renderAxis(this.element);
-
- this._handles = $('.ui-resizable-handle', this.element)
- .disableSelection();
-
- //Matching axis name
- this._handles.mouseover(function() {
- if (!self.resizing) {
- if (this.className)
- var axis = this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i);
- //Axis, default = se
- self.axis = axis && axis[1] ? axis[1] : 'se';
- }
- });
-
- //If we want to auto hide the elements
- if (o.autoHide) {
- this._handles.hide();
- $(this.element)
- .addClass("ui-resizable-autohide")
- .hover(function() {
- if (o.disabled) return;
- $(this).removeClass("ui-resizable-autohide");
- self._handles.show();
- },
- function(){
- if (o.disabled) return;
- if (!self.resizing) {
- $(this).addClass("ui-resizable-autohide");
- self._handles.hide();
- }
- });
- }
-
- //Initialize the mouse interaction
- this._mouseInit();
-
- },
-
- destroy: function() {
-
- this._mouseDestroy();
-
- var _destroy = function(exp) {
- $(exp).removeClass("ui-resizable ui-resizable-disabled ui-resizable-resizing")
- .removeData("resizable").unbind(".resizable").find('.ui-resizable-handle').remove();
- };
-
- //TODO: Unwrap at same DOM position
- if (this.elementIsWrapper) {
- _destroy(this.element);
- var wrapper = this.element;
- wrapper.after(
- this.originalElement.css({
- position: wrapper.css('position'),
- width: wrapper.outerWidth(),
- height: wrapper.outerHeight(),
- top: wrapper.css('top'),
- left: wrapper.css('left')
- })
- ).remove();
- }
-
- this.originalElement.css('resize', this.originalResizeStyle);
- _destroy(this.originalElement);
-
- return this;
- },
-
- _mouseCapture: function(event) {
- var handle = false;
- for (var i in this.handles) {
- if ($(this.handles[i])[0] == event.target) {
- handle = true;
- }
- }
-
- return !this.options.disabled && handle;
- },
-
- _mouseStart: function(event) {
-
- var o = this.options, iniPos = this.element.position(), el = this.element;
-
- this.resizing = true;
- this.documentScroll = { top: $(document).scrollTop(), left: $(document).scrollLeft() };
-
- // bugfix for http://dev.jquery.com/ticket/1749
- if (el.is('.ui-draggable') || (/absolute/).test(el.css('position'))) {
- el.css({ position: 'absolute', top: iniPos.top, left: iniPos.left });
- }
-
- //Opera fixing relative position
- if ($.browser.opera && (/relative/).test(el.css('position')))
- el.css({ position: 'relative', top: 'auto', left: 'auto' });
-
- this._renderProxy();
-
- var curleft = num(this.helper.css('left')), curtop = num(this.helper.css('top'));
-
- if (o.containment) {
- curleft += $(o.containment).scrollLeft() || 0;
- curtop += $(o.containment).scrollTop() || 0;
- }
-
- //Store needed variables
- this.offset = this.helper.offset();
- this.position = { left: curleft, top: curtop };
- this.size = this._helper ? { width: el.outerWidth(), height: el.outerHeight() } : { width: el.width(), height: el.height() };
- this.originalSize = this._helper ? { width: el.outerWidth(), height: el.outerHeight() } : { width: el.width(), height: el.height() };
- this.originalPosition = { left: curleft, top: curtop };
- this.sizeDiff = { width: el.outerWidth() - el.width(), height: el.outerHeight() - el.height() };
- this.originalMousePosition = { left: event.pageX, top: event.pageY };
-
- //Aspect Ratio
- this.aspectRatio = (typeof o.aspectRatio == 'number') ? o.aspectRatio : ((this.originalSize.width / this.originalSize.height) || 1);
-
- var cursor = $('.ui-resizable-' + this.axis).css('cursor');
- $('body').css('cursor', cursor == 'auto' ? this.axis + '-resize' : cursor);
-
- el.addClass("ui-resizable-resizing");
- this._propagate("start", event);
- return true;
- },
-
- _mouseDrag: function(event) {
-
- //Increase performance, avoid regex
- var el = this.helper, o = this.options, props = {},
- self = this, smp = this.originalMousePosition, a = this.axis;
-
- var dx = (event.pageX-smp.left)||0, dy = (event.pageY-smp.top)||0;
- var trigger = this._change[a];
- if (!trigger) return false;
-
- // Calculate the attrs that will be change
- var data = trigger.apply(this, [event, dx, dy]), ie6 = $.browser.msie && $.browser.version < 7, csdif = this.sizeDiff;
-
- // Put this in the mouseDrag handler since the user can start pressing shift while resizing
- this._updateVirtualBoundaries(event.shiftKey);
- if (this._aspectRatio || event.shiftKey)
- data = this._updateRatio(data, event);
-
- data = this._respectSize(data, event);
-
- // plugins callbacks need to be called first
- this._propagate("resize", event);
-
- el.css({
- top: this.position.top + "px", left: this.position.left + "px",
- width: this.size.width + "px", height: this.size.height + "px"
- });
-
- if (!this._helper && this._proportionallyResizeElements.length)
- this._proportionallyResize();
-
- this._updateCache(data);
-
- // calling the user callback at the end
- this._trigger('resize', event, this.ui());
-
- return false;
- },
-
- _mouseStop: function(event) {
-
- this.resizing = false;
- var o = this.options, self = this;
-
- if(this._helper) {
- var pr = this._proportionallyResizeElements, ista = pr.length && (/textarea/i).test(pr[0].nodeName),
- soffseth = ista && $.ui.hasScroll(pr[0], 'left') /* TODO - jump height */ ? 0 : self.sizeDiff.height,
- soffsetw = ista ? 0 : self.sizeDiff.width;
-
- var s = { width: (self.helper.width() - soffsetw), height: (self.helper.height() - soffseth) },
- left = (parseInt(self.element.css('left'), 10) + (self.position.left - self.originalPosition.left)) || null,
- top = (parseInt(self.element.css('top'), 10) + (self.position.top - self.originalPosition.top)) || null;
-
- if (!o.animate)
- this.element.css($.extend(s, { top: top, left: left }));
-
- self.helper.height(self.size.height);
- self.helper.width(self.size.width);
-
- if (this._helper && !o.animate) this._proportionallyResize();
- }
-
- $('body').css('cursor', 'auto');
-
- this.element.removeClass("ui-resizable-resizing");
-
- this._propagate("stop", event);
-
- if (this._helper) this.helper.remove();
- return false;
-
- },
-
- _updateVirtualBoundaries: function(forceAspectRatio) {
- var o = this.options, pMinWidth, pMaxWidth, pMinHeight, pMaxHeight, b;
-
- b = {
- minWidth: isNumber(o.minWidth) ? o.minWidth : 0,
- maxWidth: isNumber(o.maxWidth) ? o.maxWidth : Infinity,
- minHeight: isNumber(o.minHeight) ? o.minHeight : 0,
- maxHeight: isNumber(o.maxHeight) ? o.maxHeight : Infinity
- };
-
- if(this._aspectRatio || forceAspectRatio) {
- // We want to create an enclosing box whose aspect ration is the requested one
- // First, compute the "projected" size for each dimension based on the aspect ratio and other dimension
- pMinWidth = b.minHeight * this.aspectRatio;
- pMinHeight = b.minWidth / this.aspectRatio;
- pMaxWidth = b.maxHeight * this.aspectRatio;
- pMaxHeight = b.maxWidth / this.aspectRatio;
-
- if(pMinWidth > b.minWidth) b.minWidth = pMinWidth;
- if(pMinHeight > b.minHeight) b.minHeight = pMinHeight;
- if(pMaxWidth < b.maxWidth) b.maxWidth = pMaxWidth;
- if(pMaxHeight < b.maxHeight) b.maxHeight = pMaxHeight;
- }
- this._vBoundaries = b;
- },
-
- _updateCache: function(data) {
- var o = this.options;
- this.offset = this.helper.offset();
- if (isNumber(data.left)) this.position.left = data.left;
- if (isNumber(data.top)) this.position.top = data.top;
- if (isNumber(data.height)) this.size.height = data.height;
- if (isNumber(data.width)) this.size.width = data.width;
- },
-
- _updateRatio: function(data, event) {
-
- var o = this.options, cpos = this.position, csize = this.size, a = this.axis;
-
- if (isNumber(data.height)) data.width = (data.height * this.aspectRatio);
- else if (isNumber(data.width)) data.height = (data.width / this.aspectRatio);
-
- if (a == 'sw') {
- data.left = cpos.left + (csize.width - data.width);
- data.top = null;
- }
- if (a == 'nw') {
- data.top = cpos.top + (csize.height - data.height);
- data.left = cpos.left + (csize.width - data.width);
- }
-
- return data;
- },
-
- _respectSize: function(data, event) {
-
- var el = this.helper, o = this._vBoundaries, pRatio = this._aspectRatio || event.shiftKey, a = this.axis,
- ismaxw = isNumber(data.width) && o.maxWidth && (o.maxWidth < data.width), ismaxh = isNumber(data.height) && o.maxHeight && (o.maxHeight < data.height),
- isminw = isNumber(data.width) && o.minWidth && (o.minWidth > data.width), isminh = isNumber(data.height) && o.minHeight && (o.minHeight > data.height);
-
- if (isminw) data.width = o.minWidth;
- if (isminh) data.height = o.minHeight;
- if (ismaxw) data.width = o.maxWidth;
- if (ismaxh) data.height = o.maxHeight;
-
- var dw = this.originalPosition.left + this.originalSize.width, dh = this.position.top + this.size.height;
- var cw = /sw|nw|w/.test(a), ch = /nw|ne|n/.test(a);
-
- if (isminw && cw) data.left = dw - o.minWidth;
- if (ismaxw && cw) data.left = dw - o.maxWidth;
- if (isminh && ch) data.top = dh - o.minHeight;
- if (ismaxh && ch) data.top = dh - o.maxHeight;
-
- // fixing jump error on top/left - bug #2330
- var isNotwh = !data.width && !data.height;
- if (isNotwh && !data.left && data.top) data.top = null;
- else if (isNotwh && !data.top && data.left) data.left = null;
-
- return data;
- },
-
- _proportionallyResize: function() {
-
- var o = this.options;
- if (!this._proportionallyResizeElements.length) return;
- var element = this.helper || this.element;
-
- for (var i=0; i < this._proportionallyResizeElements.length; i++) {
-
- var prel = this._proportionallyResizeElements[i];
-
- if (!this.borderDif) {
- var b = [prel.css('borderTopWidth'), prel.css('borderRightWidth'), prel.css('borderBottomWidth'), prel.css('borderLeftWidth')],
- p = [prel.css('paddingTop'), prel.css('paddingRight'), prel.css('paddingBottom'), prel.css('paddingLeft')];
-
- this.borderDif = $.map(b, function(v, i) {
- var border = parseInt(v,10)||0, padding = parseInt(p[i],10)||0;
- return border + padding;
- });
- }
-
- if ($.browser.msie && !(!($(element).is(':hidden') || $(element).parents(':hidden').length)))
- continue;
-
- prel.css({
- height: (element.height() - this.borderDif[0] - this.borderDif[2]) || 0,
- width: (element.width() - this.borderDif[1] - this.borderDif[3]) || 0
- });
-
- };
-
- },
-
- _renderProxy: function() {
-
- var el = this.element, o = this.options;
- this.elementOffset = el.offset();
-
- if(this._helper) {
-
- this.helper = this.helper || $('');
-
- // fix ie6 offset TODO: This seems broken
- var ie6 = $.browser.msie && $.browser.version < 7, ie6offset = (ie6 ? 1 : 0),
- pxyoffset = ( ie6 ? 2 : -1 );
-
- this.helper.addClass(this._helper).css({
- width: this.element.outerWidth() + pxyoffset,
- height: this.element.outerHeight() + pxyoffset,
- position: 'absolute',
- left: this.elementOffset.left - ie6offset +'px',
- top: this.elementOffset.top - ie6offset +'px',
- zIndex: ++o.zIndex //TODO: Don't modify option
- });
-
- this.helper
- .appendTo("body")
- .disableSelection();
-
- } else {
- this.helper = this.element;
- }
-
- },
-
- _change: {
- e: function(event, dx, dy) {
- return { width: this.originalSize.width + dx };
- },
- w: function(event, dx, dy) {
- var o = this.options, cs = this.originalSize, sp = this.originalPosition;
- return { left: sp.left + dx, width: cs.width - dx };
- },
- n: function(event, dx, dy) {
- var o = this.options, cs = this.originalSize, sp = this.originalPosition;
- return { top: sp.top + dy, height: cs.height - dy };
- },
- s: function(event, dx, dy) {
- return { height: this.originalSize.height + dy };
- },
- se: function(event, dx, dy) {
- return $.extend(this._change.s.apply(this, arguments), this._change.e.apply(this, [event, dx, dy]));
- },
- sw: function(event, dx, dy) {
- return $.extend(this._change.s.apply(this, arguments), this._change.w.apply(this, [event, dx, dy]));
- },
- ne: function(event, dx, dy) {
- return $.extend(this._change.n.apply(this, arguments), this._change.e.apply(this, [event, dx, dy]));
- },
- nw: function(event, dx, dy) {
- return $.extend(this._change.n.apply(this, arguments), this._change.w.apply(this, [event, dx, dy]));
- }
- },
-
- _propagate: function(n, event) {
- $.ui.plugin.call(this, n, [event, this.ui()]);
- (n != "resize" && this._trigger(n, event, this.ui()));
- },
-
- plugins: {},
-
- ui: function() {
- return {
- originalElement: this.originalElement,
- element: this.element,
- helper: this.helper,
- position: this.position,
- size: this.size,
- originalSize: this.originalSize,
- originalPosition: this.originalPosition
- };
- }
-
-});
-
-$.extend($.ui.resizable, {
- version: "1.8.14"
-});
-
-/*
- * Resizable Extensions
- */
-
-$.ui.plugin.add("resizable", "alsoResize", {
-
- start: function (event, ui) {
- var self = $(this).data("resizable"), o = self.options;
-
- var _store = function (exp) {
- $(exp).each(function() {
- var el = $(this);
- el.data("resizable-alsoresize", {
- width: parseInt(el.width(), 10), height: parseInt(el.height(), 10),
- left: parseInt(el.css('left'), 10), top: parseInt(el.css('top'), 10),
- position: el.css('position') // to reset Opera on stop()
- });
- });
- };
-
- if (typeof(o.alsoResize) == 'object' && !o.alsoResize.parentNode) {
- if (o.alsoResize.length) { o.alsoResize = o.alsoResize[0]; _store(o.alsoResize); }
- else { $.each(o.alsoResize, function (exp) { _store(exp); }); }
- }else{
- _store(o.alsoResize);
- }
- },
-
- resize: function (event, ui) {
- var self = $(this).data("resizable"), o = self.options, os = self.originalSize, op = self.originalPosition;
-
- var delta = {
- height: (self.size.height - os.height) || 0, width: (self.size.width - os.width) || 0,
- top: (self.position.top - op.top) || 0, left: (self.position.left - op.left) || 0
- },
-
- _alsoResize = function (exp, c) {
- $(exp).each(function() {
- var el = $(this), start = $(this).data("resizable-alsoresize"), style = {},
- css = c && c.length ? c : el.parents(ui.originalElement[0]).length ? ['width', 'height'] : ['width', 'height', 'top', 'left'];
-
- $.each(css, function (i, prop) {
- var sum = (start[prop]||0) + (delta[prop]||0);
- if (sum && sum >= 0)
- style[prop] = sum || null;
- });
-
- // Opera fixing relative position
- if ($.browser.opera && /relative/.test(el.css('position'))) {
- self._revertToRelativePosition = true;
- el.css({ position: 'absolute', top: 'auto', left: 'auto' });
- }
-
- el.css(style);
- });
- };
-
- if (typeof(o.alsoResize) == 'object' && !o.alsoResize.nodeType) {
- $.each(o.alsoResize, function (exp, c) { _alsoResize(exp, c); });
- }else{
- _alsoResize(o.alsoResize);
- }
- },
-
- stop: function (event, ui) {
- var self = $(this).data("resizable"), o = self.options;
-
- var _reset = function (exp) {
- $(exp).each(function() {
- var el = $(this);
- // reset position for Opera - no need to verify it was changed
- el.css({ position: el.data("resizable-alsoresize").position });
- });
- };
-
- if (self._revertToRelativePosition) {
- self._revertToRelativePosition = false;
- if (typeof(o.alsoResize) == 'object' && !o.alsoResize.nodeType) {
- $.each(o.alsoResize, function (exp) { _reset(exp); });
- }else{
- _reset(o.alsoResize);
- }
- }
-
- $(this).removeData("resizable-alsoresize");
- }
-});
-
-$.ui.plugin.add("resizable", "animate", {
-
- stop: function(event, ui) {
- var self = $(this).data("resizable"), o = self.options;
-
- var pr = self._proportionallyResizeElements, ista = pr.length && (/textarea/i).test(pr[0].nodeName),
- soffseth = ista && $.ui.hasScroll(pr[0], 'left') /* TODO - jump height */ ? 0 : self.sizeDiff.height,
- soffsetw = ista ? 0 : self.sizeDiff.width;
-
- var style = { width: (self.size.width - soffsetw), height: (self.size.height - soffseth) },
- left = (parseInt(self.element.css('left'), 10) + (self.position.left - self.originalPosition.left)) || null,
- top = (parseInt(self.element.css('top'), 10) + (self.position.top - self.originalPosition.top)) || null;
-
- self.element.animate(
- $.extend(style, top && left ? { top: top, left: left } : {}), {
- duration: o.animateDuration,
- easing: o.animateEasing,
- step: function() {
-
- var data = {
- width: parseInt(self.element.css('width'), 10),
- height: parseInt(self.element.css('height'), 10),
- top: parseInt(self.element.css('top'), 10),
- left: parseInt(self.element.css('left'), 10)
- };
-
- if (pr && pr.length) $(pr[0]).css({ width: data.width, height: data.height });
-
- // propagating resize, and updating values for each animation step
- self._updateCache(data);
- self._propagate("resize", event);
-
- }
- }
- );
- }
-
-});
-
-$.ui.plugin.add("resizable", "containment", {
-
- start: function(event, ui) {
- var self = $(this).data("resizable"), o = self.options, el = self.element;
- var oc = o.containment, ce = (oc instanceof $) ? oc.get(0) : (/parent/.test(oc)) ? el.parent().get(0) : oc;
- if (!ce) return;
-
- self.containerElement = $(ce);
-
- if (/document/.test(oc) || oc == document) {
- self.containerOffset = { left: 0, top: 0 };
- self.containerPosition = { left: 0, top: 0 };
-
- self.parentData = {
- element: $(document), left: 0, top: 0,
- width: $(document).width(), height: $(document).height() || document.body.parentNode.scrollHeight
- };
- }
-
- // i'm a node, so compute top, left, right, bottom
- else {
- var element = $(ce), p = [];
- $([ "Top", "Right", "Left", "Bottom" ]).each(function(i, name) { p[i] = num(element.css("padding" + name)); });
-
- self.containerOffset = element.offset();
- self.containerPosition = element.position();
- self.containerSize = { height: (element.innerHeight() - p[3]), width: (element.innerWidth() - p[1]) };
-
- var co = self.containerOffset, ch = self.containerSize.height, cw = self.containerSize.width,
- width = ($.ui.hasScroll(ce, "left") ? ce.scrollWidth : cw ), height = ($.ui.hasScroll(ce) ? ce.scrollHeight : ch);
-
- self.parentData = {
- element: ce, left: co.left, top: co.top, width: width, height: height
- };
- }
- },
-
- resize: function(event, ui) {
- var self = $(this).data("resizable"), o = self.options,
- ps = self.containerSize, co = self.containerOffset, cs = self.size, cp = self.position,
- pRatio = self._aspectRatio || event.shiftKey, cop = { top:0, left:0 }, ce = self.containerElement;
-
- if (ce[0] != document && (/static/).test(ce.css('position'))) cop = co;
-
- if (cp.left < (self._helper ? co.left : 0)) {
- self.size.width = self.size.width + (self._helper ? (self.position.left - co.left) : (self.position.left - cop.left));
- if (pRatio) self.size.height = self.size.width / o.aspectRatio;
- self.position.left = o.helper ? co.left : 0;
- }
-
- if (cp.top < (self._helper ? co.top : 0)) {
- self.size.height = self.size.height + (self._helper ? (self.position.top - co.top) : self.position.top);
- if (pRatio) self.size.width = self.size.height * o.aspectRatio;
- self.position.top = self._helper ? co.top : 0;
- }
-
- self.offset.left = self.parentData.left+self.position.left;
- self.offset.top = self.parentData.top+self.position.top;
-
- var woset = Math.abs( (self._helper ? self.offset.left - cop.left : (self.offset.left - cop.left)) + self.sizeDiff.width ),
- hoset = Math.abs( (self._helper ? self.offset.top - cop.top : (self.offset.top - co.top)) + self.sizeDiff.height );
-
- var isParent = self.containerElement.get(0) == self.element.parent().get(0),
- isOffsetRelative = /relative|absolute/.test(self.containerElement.css('position'));
-
- if(isParent && isOffsetRelative) woset -= self.parentData.left;
-
- if (woset + self.size.width >= self.parentData.width) {
- self.size.width = self.parentData.width - woset;
- if (pRatio) self.size.height = self.size.width / self.aspectRatio;
- }
-
- if (hoset + self.size.height >= self.parentData.height) {
- self.size.height = self.parentData.height - hoset;
- if (pRatio) self.size.width = self.size.height * self.aspectRatio;
- }
- },
-
- stop: function(event, ui){
- var self = $(this).data("resizable"), o = self.options, cp = self.position,
- co = self.containerOffset, cop = self.containerPosition, ce = self.containerElement;
-
- var helper = $(self.helper), ho = helper.offset(), w = helper.outerWidth() - self.sizeDiff.width, h = helper.outerHeight() - self.sizeDiff.height;
-
- if (self._helper && !o.animate && (/relative/).test(ce.css('position')))
- $(this).css({ left: ho.left - cop.left - co.left, width: w, height: h });
-
- if (self._helper && !o.animate && (/static/).test(ce.css('position')))
- $(this).css({ left: ho.left - cop.left - co.left, width: w, height: h });
-
- }
-});
-
-$.ui.plugin.add("resizable", "ghost", {
-
- start: function(event, ui) {
-
- var self = $(this).data("resizable"), o = self.options, cs = self.size;
-
- self.ghost = self.originalElement.clone();
- self.ghost
- .css({ opacity: .25, display: 'block', position: 'relative', height: cs.height, width: cs.width, margin: 0, left: 0, top: 0 })
- .addClass('ui-resizable-ghost')
- .addClass(typeof o.ghost == 'string' ? o.ghost : '');
-
- self.ghost.appendTo(self.helper);
-
- },
-
- resize: function(event, ui){
- var self = $(this).data("resizable"), o = self.options;
- if (self.ghost) self.ghost.css({ position: 'relative', height: self.size.height, width: self.size.width });
- },
-
- stop: function(event, ui){
- var self = $(this).data("resizable"), o = self.options;
- if (self.ghost && self.helper) self.helper.get(0).removeChild(self.ghost.get(0));
- }
-
-});
-
-$.ui.plugin.add("resizable", "grid", {
-
- resize: function(event, ui) {
- var self = $(this).data("resizable"), o = self.options, cs = self.size, os = self.originalSize, op = self.originalPosition, a = self.axis, ratio = o._aspectRatio || event.shiftKey;
- o.grid = typeof o.grid == "number" ? [o.grid, o.grid] : o.grid;
- var ox = Math.round((cs.width - os.width) / (o.grid[0]||1)) * (o.grid[0]||1), oy = Math.round((cs.height - os.height) / (o.grid[1]||1)) * (o.grid[1]||1);
-
- if (/^(se|s|e)$/.test(a)) {
- self.size.width = os.width + ox;
- self.size.height = os.height + oy;
- }
- else if (/^(ne)$/.test(a)) {
- self.size.width = os.width + ox;
- self.size.height = os.height + oy;
- self.position.top = op.top - oy;
- }
- else if (/^(sw)$/.test(a)) {
- self.size.width = os.width + ox;
- self.size.height = os.height + oy;
- self.position.left = op.left - ox;
- }
- else {
- self.size.width = os.width + ox;
- self.size.height = os.height + oy;
- self.position.top = op.top - oy;
- self.position.left = op.left - ox;
- }
- }
-
-});
-
-var num = function(v) {
- return parseInt(v, 10) || 0;
-};
-
-var isNumber = function(value) {
- return !isNaN(parseInt(value, 10));
-};
-
-})(jQuery);
-/*
- * jQuery UI Selectable 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Selectables
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.mouse.js
- * jquery.ui.widget.js
- */
-(function( $, undefined ) {
-
-$.widget("ui.selectable", $.ui.mouse, {
- options: {
- appendTo: 'body',
- autoRefresh: true,
- distance: 0,
- filter: '*',
- tolerance: 'touch'
- },
- _create: function() {
- var self = this;
-
- this.element.addClass("ui-selectable");
-
- this.dragged = false;
-
- // cache selectee children based on filter
- var selectees;
- this.refresh = function() {
- selectees = $(self.options.filter, self.element[0]);
- selectees.each(function() {
- var $this = $(this);
- var pos = $this.offset();
- $.data(this, "selectable-item", {
- element: this,
- $element: $this,
- left: pos.left,
- top: pos.top,
- right: pos.left + $this.outerWidth(),
- bottom: pos.top + $this.outerHeight(),
- startselected: false,
- selected: $this.hasClass('ui-selected'),
- selecting: $this.hasClass('ui-selecting'),
- unselecting: $this.hasClass('ui-unselecting')
- });
- });
- };
- this.refresh();
-
- this.selectees = selectees.addClass("ui-selectee");
-
- this._mouseInit();
-
- this.helper = $("");
- },
-
- destroy: function() {
- this.selectees
- .removeClass("ui-selectee")
- .removeData("selectable-item");
- this.element
- .removeClass("ui-selectable ui-selectable-disabled")
- .removeData("selectable")
- .unbind(".selectable");
- this._mouseDestroy();
-
- return this;
- },
-
- _mouseStart: function(event) {
- var self = this;
-
- this.opos = [event.pageX, event.pageY];
-
- if (this.options.disabled)
- return;
-
- var options = this.options;
-
- this.selectees = $(options.filter, this.element[0]);
-
- this._trigger("start", event);
-
- $(options.appendTo).append(this.helper);
- // position helper (lasso)
- this.helper.css({
- "left": event.clientX,
- "top": event.clientY,
- "width": 0,
- "height": 0
- });
-
- if (options.autoRefresh) {
- this.refresh();
- }
-
- this.selectees.filter('.ui-selected').each(function() {
- var selectee = $.data(this, "selectable-item");
- selectee.startselected = true;
- if (!event.metaKey) {
- selectee.$element.removeClass('ui-selected');
- selectee.selected = false;
- selectee.$element.addClass('ui-unselecting');
- selectee.unselecting = true;
- // selectable UNSELECTING callback
- self._trigger("unselecting", event, {
- unselecting: selectee.element
- });
- }
- });
-
- $(event.target).parents().andSelf().each(function() {
- var selectee = $.data(this, "selectable-item");
- if (selectee) {
- var doSelect = !event.metaKey || !selectee.$element.hasClass('ui-selected');
- selectee.$element
- .removeClass(doSelect ? "ui-unselecting" : "ui-selected")
- .addClass(doSelect ? "ui-selecting" : "ui-unselecting");
- selectee.unselecting = !doSelect;
- selectee.selecting = doSelect;
- selectee.selected = doSelect;
- // selectable (UN)SELECTING callback
- if (doSelect) {
- self._trigger("selecting", event, {
- selecting: selectee.element
- });
- } else {
- self._trigger("unselecting", event, {
- unselecting: selectee.element
- });
- }
- return false;
- }
- });
-
- },
-
- _mouseDrag: function(event) {
- var self = this;
- this.dragged = true;
-
- if (this.options.disabled)
- return;
-
- var options = this.options;
-
- var x1 = this.opos[0], y1 = this.opos[1], x2 = event.pageX, y2 = event.pageY;
- if (x1 > x2) { var tmp = x2; x2 = x1; x1 = tmp; }
- if (y1 > y2) { var tmp = y2; y2 = y1; y1 = tmp; }
- this.helper.css({left: x1, top: y1, width: x2-x1, height: y2-y1});
-
- this.selectees.each(function() {
- var selectee = $.data(this, "selectable-item");
- //prevent helper from being selected if appendTo: selectable
- if (!selectee || selectee.element == self.element[0])
- return;
- var hit = false;
- if (options.tolerance == 'touch') {
- hit = ( !(selectee.left > x2 || selectee.right < x1 || selectee.top > y2 || selectee.bottom < y1) );
- } else if (options.tolerance == 'fit') {
- hit = (selectee.left > x1 && selectee.right < x2 && selectee.top > y1 && selectee.bottom < y2);
- }
-
- if (hit) {
- // SELECT
- if (selectee.selected) {
- selectee.$element.removeClass('ui-selected');
- selectee.selected = false;
- }
- if (selectee.unselecting) {
- selectee.$element.removeClass('ui-unselecting');
- selectee.unselecting = false;
- }
- if (!selectee.selecting) {
- selectee.$element.addClass('ui-selecting');
- selectee.selecting = true;
- // selectable SELECTING callback
- self._trigger("selecting", event, {
- selecting: selectee.element
- });
- }
- } else {
- // UNSELECT
- if (selectee.selecting) {
- if (event.metaKey && selectee.startselected) {
- selectee.$element.removeClass('ui-selecting');
- selectee.selecting = false;
- selectee.$element.addClass('ui-selected');
- selectee.selected = true;
- } else {
- selectee.$element.removeClass('ui-selecting');
- selectee.selecting = false;
- if (selectee.startselected) {
- selectee.$element.addClass('ui-unselecting');
- selectee.unselecting = true;
- }
- // selectable UNSELECTING callback
- self._trigger("unselecting", event, {
- unselecting: selectee.element
- });
- }
- }
- if (selectee.selected) {
- if (!event.metaKey && !selectee.startselected) {
- selectee.$element.removeClass('ui-selected');
- selectee.selected = false;
-
- selectee.$element.addClass('ui-unselecting');
- selectee.unselecting = true;
- // selectable UNSELECTING callback
- self._trigger("unselecting", event, {
- unselecting: selectee.element
- });
- }
- }
- }
- });
-
- return false;
- },
-
- _mouseStop: function(event) {
- var self = this;
-
- this.dragged = false;
-
- var options = this.options;
-
- $('.ui-unselecting', this.element[0]).each(function() {
- var selectee = $.data(this, "selectable-item");
- selectee.$element.removeClass('ui-unselecting');
- selectee.unselecting = false;
- selectee.startselected = false;
- self._trigger("unselected", event, {
- unselected: selectee.element
- });
- });
- $('.ui-selecting', this.element[0]).each(function() {
- var selectee = $.data(this, "selectable-item");
- selectee.$element.removeClass('ui-selecting').addClass('ui-selected');
- selectee.selecting = false;
- selectee.selected = true;
- selectee.startselected = true;
- self._trigger("selected", event, {
- selected: selectee.element
- });
- });
- this._trigger("stop", event);
-
- this.helper.remove();
-
- return false;
- }
-
-});
-
-$.extend($.ui.selectable, {
- version: "1.8.14"
-});
-
-})(jQuery);
-/*
- * jQuery UI Sortable 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Sortables
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.mouse.js
- * jquery.ui.widget.js
- */
-(function( $, undefined ) {
-
-$.widget("ui.sortable", $.ui.mouse, {
- widgetEventPrefix: "sort",
- options: {
- appendTo: "parent",
- axis: false,
- connectWith: false,
- containment: false,
- cursor: 'auto',
- cursorAt: false,
- dropOnEmpty: true,
- forcePlaceholderSize: false,
- forceHelperSize: false,
- grid: false,
- handle: false,
- helper: "original",
- items: '> *',
- opacity: false,
- placeholder: false,
- revert: false,
- scroll: true,
- scrollSensitivity: 20,
- scrollSpeed: 20,
- scope: "default",
- tolerance: "intersect",
- zIndex: 1000
- },
- _create: function() {
-
- var o = this.options;
- this.containerCache = {};
- this.element.addClass("ui-sortable");
-
- //Get the items
- this.refresh();
-
- //Let's determine if the items are being displayed horizontally
- this.floating = this.items.length ? o.axis === 'x' || (/left|right/).test(this.items[0].item.css('float')) || (/inline|table-cell/).test(this.items[0].item.css('display')) : false;
-
- //Let's determine the parent's offset
- this.offset = this.element.offset();
-
- //Initialize mouse events for interaction
- this._mouseInit();
-
- },
-
- destroy: function() {
- this.element
- .removeClass("ui-sortable ui-sortable-disabled")
- .removeData("sortable")
- .unbind(".sortable");
- this._mouseDestroy();
-
- for ( var i = this.items.length - 1; i >= 0; i-- )
- this.items[i].item.removeData("sortable-item");
-
- return this;
- },
-
- _setOption: function(key, value){
- if ( key === "disabled" ) {
- this.options[ key ] = value;
-
- this.widget()
- [ value ? "addClass" : "removeClass"]( "ui-sortable-disabled" );
- } else {
- // Don't call widget base _setOption for disable as it adds ui-state-disabled class
- $.Widget.prototype._setOption.apply(this, arguments);
- }
- },
-
- _mouseCapture: function(event, overrideHandle) {
-
- if (this.reverting) {
- return false;
- }
-
- if(this.options.disabled || this.options.type == 'static') return false;
-
- //We have to refresh the items data once first
- this._refreshItems(event);
-
- //Find out if the clicked node (or one of its parents) is a actual item in this.items
- var currentItem = null, self = this, nodes = $(event.target).parents().each(function() {
- if($.data(this, 'sortable-item') == self) {
- currentItem = $(this);
- return false;
- }
- });
- if($.data(event.target, 'sortable-item') == self) currentItem = $(event.target);
-
- if(!currentItem) return false;
- if(this.options.handle && !overrideHandle) {
- var validHandle = false;
-
- $(this.options.handle, currentItem).find("*").andSelf().each(function() { if(this == event.target) validHandle = true; });
- if(!validHandle) return false;
- }
-
- this.currentItem = currentItem;
- this._removeCurrentsFromItems();
- return true;
-
- },
-
- _mouseStart: function(event, overrideHandle, noActivation) {
-
- var o = this.options, self = this;
- this.currentContainer = this;
-
- //We only need to call refreshPositions, because the refreshItems call has been moved to mouseCapture
- this.refreshPositions();
-
- //Create and append the visible helper
- this.helper = this._createHelper(event);
-
- //Cache the helper size
- this._cacheHelperProportions();
-
- /*
- * - Position generation -
- * This block generates everything position related - it's the core of draggables.
- */
-
- //Cache the margins of the original element
- this._cacheMargins();
-
- //Get the next scrolling parent
- this.scrollParent = this.helper.scrollParent();
-
- //The element's absolute position on the page minus margins
- this.offset = this.currentItem.offset();
- this.offset = {
- top: this.offset.top - this.margins.top,
- left: this.offset.left - this.margins.left
- };
-
- // Only after we got the offset, we can change the helper's position to absolute
- // TODO: Still need to figure out a way to make relative sorting possible
- this.helper.css("position", "absolute");
- this.cssPosition = this.helper.css("position");
-
- $.extend(this.offset, {
- click: { //Where the click happened, relative to the element
- left: event.pageX - this.offset.left,
- top: event.pageY - this.offset.top
- },
- parent: this._getParentOffset(),
- relative: this._getRelativeOffset() //This is a relative to absolute position minus the actual position calculation - only used for relative positioned helper
- });
-
- //Generate the original position
- this.originalPosition = this._generatePosition(event);
- this.originalPageX = event.pageX;
- this.originalPageY = event.pageY;
-
- //Adjust the mouse offset relative to the helper if 'cursorAt' is supplied
- (o.cursorAt && this._adjustOffsetFromHelper(o.cursorAt));
-
- //Cache the former DOM position
- this.domPosition = { prev: this.currentItem.prev()[0], parent: this.currentItem.parent()[0] };
-
- //If the helper is not the original, hide the original so it's not playing any role during the drag, won't cause anything bad this way
- if(this.helper[0] != this.currentItem[0]) {
- this.currentItem.hide();
- }
-
- //Create the placeholder
- this._createPlaceholder();
-
- //Set a containment if given in the options
- if(o.containment)
- this._setContainment();
-
- if(o.cursor) { // cursor option
- if ($('body').css("cursor")) this._storedCursor = $('body').css("cursor");
- $('body').css("cursor", o.cursor);
- }
-
- if(o.opacity) { // opacity option
- if (this.helper.css("opacity")) this._storedOpacity = this.helper.css("opacity");
- this.helper.css("opacity", o.opacity);
- }
-
- if(o.zIndex) { // zIndex option
- if (this.helper.css("zIndex")) this._storedZIndex = this.helper.css("zIndex");
- this.helper.css("zIndex", o.zIndex);
- }
-
- //Prepare scrolling
- if(this.scrollParent[0] != document && this.scrollParent[0].tagName != 'HTML')
- this.overflowOffset = this.scrollParent.offset();
-
- //Call callbacks
- this._trigger("start", event, this._uiHash());
-
- //Recache the helper size
- if(!this._preserveHelperProportions)
- this._cacheHelperProportions();
-
-
- //Post 'activate' events to possible containers
- if(!noActivation) {
- for (var i = this.containers.length - 1; i >= 0; i--) { this.containers[i]._trigger("activate", event, self._uiHash(this)); }
- }
-
- //Prepare possible droppables
- if($.ui.ddmanager)
- $.ui.ddmanager.current = this;
-
- if ($.ui.ddmanager && !o.dropBehaviour)
- $.ui.ddmanager.prepareOffsets(this, event);
-
- this.dragging = true;
-
- this.helper.addClass("ui-sortable-helper");
- this._mouseDrag(event); //Execute the drag once - this causes the helper not to be visible before getting its correct position
- return true;
-
- },
-
- _mouseDrag: function(event) {
-
- //Compute the helpers position
- this.position = this._generatePosition(event);
- this.positionAbs = this._convertPositionTo("absolute");
-
- if (!this.lastPositionAbs) {
- this.lastPositionAbs = this.positionAbs;
- }
-
- //Do scrolling
- if(this.options.scroll) {
- var o = this.options, scrolled = false;
- if(this.scrollParent[0] != document && this.scrollParent[0].tagName != 'HTML') {
-
- if((this.overflowOffset.top + this.scrollParent[0].offsetHeight) - event.pageY < o.scrollSensitivity)
- this.scrollParent[0].scrollTop = scrolled = this.scrollParent[0].scrollTop + o.scrollSpeed;
- else if(event.pageY - this.overflowOffset.top < o.scrollSensitivity)
- this.scrollParent[0].scrollTop = scrolled = this.scrollParent[0].scrollTop - o.scrollSpeed;
-
- if((this.overflowOffset.left + this.scrollParent[0].offsetWidth) - event.pageX < o.scrollSensitivity)
- this.scrollParent[0].scrollLeft = scrolled = this.scrollParent[0].scrollLeft + o.scrollSpeed;
- else if(event.pageX - this.overflowOffset.left < o.scrollSensitivity)
- this.scrollParent[0].scrollLeft = scrolled = this.scrollParent[0].scrollLeft - o.scrollSpeed;
-
- } else {
-
- if(event.pageY - $(document).scrollTop() < o.scrollSensitivity)
- scrolled = $(document).scrollTop($(document).scrollTop() - o.scrollSpeed);
- else if($(window).height() - (event.pageY - $(document).scrollTop()) < o.scrollSensitivity)
- scrolled = $(document).scrollTop($(document).scrollTop() + o.scrollSpeed);
-
- if(event.pageX - $(document).scrollLeft() < o.scrollSensitivity)
- scrolled = $(document).scrollLeft($(document).scrollLeft() - o.scrollSpeed);
- else if($(window).width() - (event.pageX - $(document).scrollLeft()) < o.scrollSensitivity)
- scrolled = $(document).scrollLeft($(document).scrollLeft() + o.scrollSpeed);
-
- }
-
- if(scrolled !== false && $.ui.ddmanager && !o.dropBehaviour)
- $.ui.ddmanager.prepareOffsets(this, event);
- }
-
- //Regenerate the absolute position used for position checks
- this.positionAbs = this._convertPositionTo("absolute");
-
- //Set the helper position
- if(!this.options.axis || this.options.axis != "y") this.helper[0].style.left = this.position.left+'px';
- if(!this.options.axis || this.options.axis != "x") this.helper[0].style.top = this.position.top+'px';
-
- //Rearrange
- for (var i = this.items.length - 1; i >= 0; i--) {
-
- //Cache variables and intersection, continue if no intersection
- var item = this.items[i], itemElement = item.item[0], intersection = this._intersectsWithPointer(item);
- if (!intersection) continue;
-
- if(itemElement != this.currentItem[0] //cannot intersect with itself
- && this.placeholder[intersection == 1 ? "next" : "prev"]()[0] != itemElement //no useless actions that have been done before
- && !$.ui.contains(this.placeholder[0], itemElement) //no action if the item moved is the parent of the item checked
- && (this.options.type == 'semi-dynamic' ? !$.ui.contains(this.element[0], itemElement) : true)
- //&& itemElement.parentNode == this.placeholder[0].parentNode // only rearrange items within the same container
- ) {
-
- this.direction = intersection == 1 ? "down" : "up";
-
- if (this.options.tolerance == "pointer" || this._intersectsWithSides(item)) {
- this._rearrange(event, item);
- } else {
- break;
- }
-
- this._trigger("change", event, this._uiHash());
- break;
- }
- }
-
- //Post events to containers
- this._contactContainers(event);
-
- //Interconnect with droppables
- if($.ui.ddmanager) $.ui.ddmanager.drag(this, event);
-
- //Call callbacks
- this._trigger('sort', event, this._uiHash());
-
- this.lastPositionAbs = this.positionAbs;
- return false;
-
- },
-
- _mouseStop: function(event, noPropagation) {
-
- if(!event) return;
-
- //If we are using droppables, inform the manager about the drop
- if ($.ui.ddmanager && !this.options.dropBehaviour)
- $.ui.ddmanager.drop(this, event);
-
- if(this.options.revert) {
- var self = this;
- var cur = self.placeholder.offset();
-
- self.reverting = true;
-
- $(this.helper).animate({
- left: cur.left - this.offset.parent.left - self.margins.left + (this.offsetParent[0] == document.body ? 0 : this.offsetParent[0].scrollLeft),
- top: cur.top - this.offset.parent.top - self.margins.top + (this.offsetParent[0] == document.body ? 0 : this.offsetParent[0].scrollTop)
- }, parseInt(this.options.revert, 10) || 500, function() {
- self._clear(event);
- });
- } else {
- this._clear(event, noPropagation);
- }
-
- return false;
-
- },
-
- cancel: function() {
-
- var self = this;
-
- if(this.dragging) {
-
- this._mouseUp({ target: null });
-
- if(this.options.helper == "original")
- this.currentItem.css(this._storedCSS).removeClass("ui-sortable-helper");
- else
- this.currentItem.show();
-
- //Post deactivating events to containers
- for (var i = this.containers.length - 1; i >= 0; i--){
- this.containers[i]._trigger("deactivate", null, self._uiHash(this));
- if(this.containers[i].containerCache.over) {
- this.containers[i]._trigger("out", null, self._uiHash(this));
- this.containers[i].containerCache.over = 0;
- }
- }
-
- }
-
- if (this.placeholder) {
- //$(this.placeholder[0]).remove(); would have been the jQuery way - unfortunately, it unbinds ALL events from the original node!
- if(this.placeholder[0].parentNode) this.placeholder[0].parentNode.removeChild(this.placeholder[0]);
- if(this.options.helper != "original" && this.helper && this.helper[0].parentNode) this.helper.remove();
-
- $.extend(this, {
- helper: null,
- dragging: false,
- reverting: false,
- _noFinalSort: null
- });
-
- if(this.domPosition.prev) {
- $(this.domPosition.prev).after(this.currentItem);
- } else {
- $(this.domPosition.parent).prepend(this.currentItem);
- }
- }
-
- return this;
-
- },
-
- serialize: function(o) {
-
- var items = this._getItemsAsjQuery(o && o.connected);
- var str = []; o = o || {};
-
- $(items).each(function() {
- var res = ($(o.item || this).attr(o.attribute || 'id') || '').match(o.expression || (/(.+)[-=_](.+)/));
- if(res) str.push((o.key || res[1]+'[]')+'='+(o.key && o.expression ? res[1] : res[2]));
- });
-
- if(!str.length && o.key) {
- str.push(o.key + '=');
- }
-
- return str.join('&');
-
- },
-
- toArray: function(o) {
-
- var items = this._getItemsAsjQuery(o && o.connected);
- var ret = []; o = o || {};
-
- items.each(function() { ret.push($(o.item || this).attr(o.attribute || 'id') || ''); });
- return ret;
-
- },
-
- /* Be careful with the following core functions */
- _intersectsWith: function(item) {
-
- var x1 = this.positionAbs.left,
- x2 = x1 + this.helperProportions.width,
- y1 = this.positionAbs.top,
- y2 = y1 + this.helperProportions.height;
-
- var l = item.left,
- r = l + item.width,
- t = item.top,
- b = t + item.height;
-
- var dyClick = this.offset.click.top,
- dxClick = this.offset.click.left;
-
- var isOverElement = (y1 + dyClick) > t && (y1 + dyClick) < b && (x1 + dxClick) > l && (x1 + dxClick) < r;
-
- if( this.options.tolerance == "pointer"
- || this.options.forcePointerForContainers
- || (this.options.tolerance != "pointer" && this.helperProportions[this.floating ? 'width' : 'height'] > item[this.floating ? 'width' : 'height'])
- ) {
- return isOverElement;
- } else {
-
- return (l < x1 + (this.helperProportions.width / 2) // Right Half
- && x2 - (this.helperProportions.width / 2) < r // Left Half
- && t < y1 + (this.helperProportions.height / 2) // Bottom Half
- && y2 - (this.helperProportions.height / 2) < b ); // Top Half
-
- }
- },
-
- _intersectsWithPointer: function(item) {
-
- var isOverElementHeight = $.ui.isOverAxis(this.positionAbs.top + this.offset.click.top, item.top, item.height),
- isOverElementWidth = $.ui.isOverAxis(this.positionAbs.left + this.offset.click.left, item.left, item.width),
- isOverElement = isOverElementHeight && isOverElementWidth,
- verticalDirection = this._getDragVerticalDirection(),
- horizontalDirection = this._getDragHorizontalDirection();
-
- if (!isOverElement)
- return false;
-
- return this.floating ?
- ( ((horizontalDirection && horizontalDirection == "right") || verticalDirection == "down") ? 2 : 1 )
- : ( verticalDirection && (verticalDirection == "down" ? 2 : 1) );
-
- },
-
- _intersectsWithSides: function(item) {
-
- var isOverBottomHalf = $.ui.isOverAxis(this.positionAbs.top + this.offset.click.top, item.top + (item.height/2), item.height),
- isOverRightHalf = $.ui.isOverAxis(this.positionAbs.left + this.offset.click.left, item.left + (item.width/2), item.width),
- verticalDirection = this._getDragVerticalDirection(),
- horizontalDirection = this._getDragHorizontalDirection();
-
- if (this.floating && horizontalDirection) {
- return ((horizontalDirection == "right" && isOverRightHalf) || (horizontalDirection == "left" && !isOverRightHalf));
- } else {
- return verticalDirection && ((verticalDirection == "down" && isOverBottomHalf) || (verticalDirection == "up" && !isOverBottomHalf));
- }
-
- },
-
- _getDragVerticalDirection: function() {
- var delta = this.positionAbs.top - this.lastPositionAbs.top;
- return delta != 0 && (delta > 0 ? "down" : "up");
- },
-
- _getDragHorizontalDirection: function() {
- var delta = this.positionAbs.left - this.lastPositionAbs.left;
- return delta != 0 && (delta > 0 ? "right" : "left");
- },
-
- refresh: function(event) {
- this._refreshItems(event);
- this.refreshPositions();
- return this;
- },
-
- _connectWith: function() {
- var options = this.options;
- return options.connectWith.constructor == String
- ? [options.connectWith]
- : options.connectWith;
- },
-
- _getItemsAsjQuery: function(connected) {
-
- var self = this;
- var items = [];
- var queries = [];
- var connectWith = this._connectWith();
-
- if(connectWith && connected) {
- for (var i = connectWith.length - 1; i >= 0; i--){
- var cur = $(connectWith[i]);
- for (var j = cur.length - 1; j >= 0; j--){
- var inst = $.data(cur[j], 'sortable');
- if(inst && inst != this && !inst.options.disabled) {
- queries.push([$.isFunction(inst.options.items) ? inst.options.items.call(inst.element) : $(inst.options.items, inst.element).not(".ui-sortable-helper").not('.ui-sortable-placeholder'), inst]);
- }
- };
- };
- }
-
- queries.push([$.isFunction(this.options.items) ? this.options.items.call(this.element, null, { options: this.options, item: this.currentItem }) : $(this.options.items, this.element).not(".ui-sortable-helper").not('.ui-sortable-placeholder'), this]);
-
- for (var i = queries.length - 1; i >= 0; i--){
- queries[i][0].each(function() {
- items.push(this);
- });
- };
-
- return $(items);
-
- },
-
- _removeCurrentsFromItems: function() {
-
- var list = this.currentItem.find(":data(sortable-item)");
-
- for (var i=0; i < this.items.length; i++) {
-
- for (var j=0; j < list.length; j++) {
- if(list[j] == this.items[i].item[0])
- this.items.splice(i,1);
- };
-
- };
-
- },
-
- _refreshItems: function(event) {
-
- this.items = [];
- this.containers = [this];
- var items = this.items;
- var self = this;
- var queries = [[$.isFunction(this.options.items) ? this.options.items.call(this.element[0], event, { item: this.currentItem }) : $(this.options.items, this.element), this]];
- var connectWith = this._connectWith();
-
- if(connectWith) {
- for (var i = connectWith.length - 1; i >= 0; i--){
- var cur = $(connectWith[i]);
- for (var j = cur.length - 1; j >= 0; j--){
- var inst = $.data(cur[j], 'sortable');
- if(inst && inst != this && !inst.options.disabled) {
- queries.push([$.isFunction(inst.options.items) ? inst.options.items.call(inst.element[0], event, { item: this.currentItem }) : $(inst.options.items, inst.element), inst]);
- this.containers.push(inst);
- }
- };
- };
- }
-
- for (var i = queries.length - 1; i >= 0; i--) {
- var targetData = queries[i][1];
- var _queries = queries[i][0];
-
- for (var j=0, queriesLength = _queries.length; j < queriesLength; j++) {
- var item = $(_queries[j]);
-
- item.data('sortable-item', targetData); // Data for target checking (mouse manager)
-
- items.push({
- item: item,
- instance: targetData,
- width: 0, height: 0,
- left: 0, top: 0
- });
- };
- };
-
- },
-
- refreshPositions: function(fast) {
-
- //This has to be redone because due to the item being moved out/into the offsetParent, the offsetParent's position will change
- if(this.offsetParent && this.helper) {
- this.offset.parent = this._getParentOffset();
- }
-
- for (var i = this.items.length - 1; i >= 0; i--){
- var item = this.items[i];
-
- //We ignore calculating positions of all connected containers when we're not over them
- if(item.instance != this.currentContainer && this.currentContainer && item.item[0] != this.currentItem[0])
- continue;
-
- var t = this.options.toleranceElement ? $(this.options.toleranceElement, item.item) : item.item;
-
- if (!fast) {
- item.width = t.outerWidth();
- item.height = t.outerHeight();
- }
-
- var p = t.offset();
- item.left = p.left;
- item.top = p.top;
- };
-
- if(this.options.custom && this.options.custom.refreshContainers) {
- this.options.custom.refreshContainers.call(this);
- } else {
- for (var i = this.containers.length - 1; i >= 0; i--){
- var p = this.containers[i].element.offset();
- this.containers[i].containerCache.left = p.left;
- this.containers[i].containerCache.top = p.top;
- this.containers[i].containerCache.width = this.containers[i].element.outerWidth();
- this.containers[i].containerCache.height = this.containers[i].element.outerHeight();
- };
- }
-
- return this;
- },
-
- _createPlaceholder: function(that) {
-
- var self = that || this, o = self.options;
-
- if(!o.placeholder || o.placeholder.constructor == String) {
- var className = o.placeholder;
- o.placeholder = {
- element: function() {
-
- var el = $(document.createElement(self.currentItem[0].nodeName))
- .addClass(className || self.currentItem[0].className+" ui-sortable-placeholder")
- .removeClass("ui-sortable-helper")[0];
-
- if(!className)
- el.style.visibility = "hidden";
-
- return el;
- },
- update: function(container, p) {
-
- // 1. If a className is set as 'placeholder option, we don't force sizes - the class is responsible for that
- // 2. The option 'forcePlaceholderSize can be enabled to force it even if a class name is specified
- if(className && !o.forcePlaceholderSize) return;
-
- //If the element doesn't have a actual height by itself (without styles coming from a stylesheet), it receives the inline height from the dragged item
- if(!p.height()) { p.height(self.currentItem.innerHeight() - parseInt(self.currentItem.css('paddingTop')||0, 10) - parseInt(self.currentItem.css('paddingBottom')||0, 10)); };
- if(!p.width()) { p.width(self.currentItem.innerWidth() - parseInt(self.currentItem.css('paddingLeft')||0, 10) - parseInt(self.currentItem.css('paddingRight')||0, 10)); };
- }
- };
- }
-
- //Create the placeholder
- self.placeholder = $(o.placeholder.element.call(self.element, self.currentItem));
-
- //Append it after the actual current item
- self.currentItem.after(self.placeholder);
-
- //Update the size of the placeholder (TODO: Logic to fuzzy, see line 316/317)
- o.placeholder.update(self, self.placeholder);
-
- },
-
- _contactContainers: function(event) {
-
- // get innermost container that intersects with item
- var innermostContainer = null, innermostIndex = null;
-
-
- for (var i = this.containers.length - 1; i >= 0; i--){
-
- // never consider a container that's located within the item itself
- if($.ui.contains(this.currentItem[0], this.containers[i].element[0]))
- continue;
-
- if(this._intersectsWith(this.containers[i].containerCache)) {
-
- // if we've already found a container and it's more "inner" than this, then continue
- if(innermostContainer && $.ui.contains(this.containers[i].element[0], innermostContainer.element[0]))
- continue;
-
- innermostContainer = this.containers[i];
- innermostIndex = i;
-
- } else {
- // container doesn't intersect. trigger "out" event if necessary
- if(this.containers[i].containerCache.over) {
- this.containers[i]._trigger("out", event, this._uiHash(this));
- this.containers[i].containerCache.over = 0;
- }
- }
-
- }
-
- // if no intersecting containers found, return
- if(!innermostContainer) return;
-
- // move the item into the container if it's not there already
- if(this.containers.length === 1) {
- this.containers[innermostIndex]._trigger("over", event, this._uiHash(this));
- this.containers[innermostIndex].containerCache.over = 1;
- } else if(this.currentContainer != this.containers[innermostIndex]) {
-
- //When entering a new container, we will find the item with the least distance and append our item near it
- var dist = 10000; var itemWithLeastDistance = null; var base = this.positionAbs[this.containers[innermostIndex].floating ? 'left' : 'top'];
- for (var j = this.items.length - 1; j >= 0; j--) {
- if(!$.ui.contains(this.containers[innermostIndex].element[0], this.items[j].item[0])) continue;
- var cur = this.items[j][this.containers[innermostIndex].floating ? 'left' : 'top'];
- if(Math.abs(cur - base) < dist) {
- dist = Math.abs(cur - base); itemWithLeastDistance = this.items[j];
- }
- }
-
- if(!itemWithLeastDistance && !this.options.dropOnEmpty) //Check if dropOnEmpty is enabled
- return;
-
- this.currentContainer = this.containers[innermostIndex];
- itemWithLeastDistance ? this._rearrange(event, itemWithLeastDistance, null, true) : this._rearrange(event, null, this.containers[innermostIndex].element, true);
- this._trigger("change", event, this._uiHash());
- this.containers[innermostIndex]._trigger("change", event, this._uiHash(this));
-
- //Update the placeholder
- this.options.placeholder.update(this.currentContainer, this.placeholder);
-
- this.containers[innermostIndex]._trigger("over", event, this._uiHash(this));
- this.containers[innermostIndex].containerCache.over = 1;
- }
-
-
- },
-
- _createHelper: function(event) {
-
- var o = this.options;
- var helper = $.isFunction(o.helper) ? $(o.helper.apply(this.element[0], [event, this.currentItem])) : (o.helper == 'clone' ? this.currentItem.clone() : this.currentItem);
-
- if(!helper.parents('body').length) //Add the helper to the DOM if that didn't happen already
- $(o.appendTo != 'parent' ? o.appendTo : this.currentItem[0].parentNode)[0].appendChild(helper[0]);
-
- if(helper[0] == this.currentItem[0])
- this._storedCSS = { width: this.currentItem[0].style.width, height: this.currentItem[0].style.height, position: this.currentItem.css("position"), top: this.currentItem.css("top"), left: this.currentItem.css("left") };
-
- if(helper[0].style.width == '' || o.forceHelperSize) helper.width(this.currentItem.width());
- if(helper[0].style.height == '' || o.forceHelperSize) helper.height(this.currentItem.height());
-
- return helper;
-
- },
-
- _adjustOffsetFromHelper: function(obj) {
- if (typeof obj == 'string') {
- obj = obj.split(' ');
- }
- if ($.isArray(obj)) {
- obj = {left: +obj[0], top: +obj[1] || 0};
- }
- if ('left' in obj) {
- this.offset.click.left = obj.left + this.margins.left;
- }
- if ('right' in obj) {
- this.offset.click.left = this.helperProportions.width - obj.right + this.margins.left;
- }
- if ('top' in obj) {
- this.offset.click.top = obj.top + this.margins.top;
- }
- if ('bottom' in obj) {
- this.offset.click.top = this.helperProportions.height - obj.bottom + this.margins.top;
- }
- },
-
- _getParentOffset: function() {
-
-
- //Get the offsetParent and cache its position
- this.offsetParent = this.helper.offsetParent();
- var po = this.offsetParent.offset();
-
- // This is a special case where we need to modify a offset calculated on start, since the following happened:
- // 1. The position of the helper is absolute, so it's position is calculated based on the next positioned parent
- // 2. The actual offset parent is a child of the scroll parent, and the scroll parent isn't the document, which means that
- // the scroll is included in the initial calculation of the offset of the parent, and never recalculated upon drag
- if(this.cssPosition == 'absolute' && this.scrollParent[0] != document && $.ui.contains(this.scrollParent[0], this.offsetParent[0])) {
- po.left += this.scrollParent.scrollLeft();
- po.top += this.scrollParent.scrollTop();
- }
-
- if((this.offsetParent[0] == document.body) //This needs to be actually done for all browsers, since pageX/pageY includes this information
- || (this.offsetParent[0].tagName && this.offsetParent[0].tagName.toLowerCase() == 'html' && $.browser.msie)) //Ugly IE fix
- po = { top: 0, left: 0 };
-
- return {
- top: po.top + (parseInt(this.offsetParent.css("borderTopWidth"),10) || 0),
- left: po.left + (parseInt(this.offsetParent.css("borderLeftWidth"),10) || 0)
- };
-
- },
-
- _getRelativeOffset: function() {
-
- if(this.cssPosition == "relative") {
- var p = this.currentItem.position();
- return {
- top: p.top - (parseInt(this.helper.css("top"),10) || 0) + this.scrollParent.scrollTop(),
- left: p.left - (parseInt(this.helper.css("left"),10) || 0) + this.scrollParent.scrollLeft()
- };
- } else {
- return { top: 0, left: 0 };
- }
-
- },
-
- _cacheMargins: function() {
- this.margins = {
- left: (parseInt(this.currentItem.css("marginLeft"),10) || 0),
- top: (parseInt(this.currentItem.css("marginTop"),10) || 0)
- };
- },
-
- _cacheHelperProportions: function() {
- this.helperProportions = {
- width: this.helper.outerWidth(),
- height: this.helper.outerHeight()
- };
- },
-
- _setContainment: function() {
-
- var o = this.options;
- if(o.containment == 'parent') o.containment = this.helper[0].parentNode;
- if(o.containment == 'document' || o.containment == 'window') this.containment = [
- 0 - this.offset.relative.left - this.offset.parent.left,
- 0 - this.offset.relative.top - this.offset.parent.top,
- $(o.containment == 'document' ? document : window).width() - this.helperProportions.width - this.margins.left,
- ($(o.containment == 'document' ? document : window).height() || document.body.parentNode.scrollHeight) - this.helperProportions.height - this.margins.top
- ];
-
- if(!(/^(document|window|parent)$/).test(o.containment)) {
- var ce = $(o.containment)[0];
- var co = $(o.containment).offset();
- var over = ($(ce).css("overflow") != 'hidden');
-
- this.containment = [
- co.left + (parseInt($(ce).css("borderLeftWidth"),10) || 0) + (parseInt($(ce).css("paddingLeft"),10) || 0) - this.margins.left,
- co.top + (parseInt($(ce).css("borderTopWidth"),10) || 0) + (parseInt($(ce).css("paddingTop"),10) || 0) - this.margins.top,
- co.left+(over ? Math.max(ce.scrollWidth,ce.offsetWidth) : ce.offsetWidth) - (parseInt($(ce).css("borderLeftWidth"),10) || 0) - (parseInt($(ce).css("paddingRight"),10) || 0) - this.helperProportions.width - this.margins.left,
- co.top+(over ? Math.max(ce.scrollHeight,ce.offsetHeight) : ce.offsetHeight) - (parseInt($(ce).css("borderTopWidth"),10) || 0) - (parseInt($(ce).css("paddingBottom"),10) || 0) - this.helperProportions.height - this.margins.top
- ];
- }
-
- },
-
- _convertPositionTo: function(d, pos) {
-
- if(!pos) pos = this.position;
- var mod = d == "absolute" ? 1 : -1;
- var o = this.options, scroll = this.cssPosition == 'absolute' && !(this.scrollParent[0] != document && $.ui.contains(this.scrollParent[0], this.offsetParent[0])) ? this.offsetParent : this.scrollParent, scrollIsRootNode = (/(html|body)/i).test(scroll[0].tagName);
-
- return {
- top: (
- pos.top // The absolute mouse position
- + this.offset.relative.top * mod // Only for relative positioned nodes: Relative offset from element to offset parent
- + this.offset.parent.top * mod // The offsetParent's offset without borders (offset + border)
- - ($.browser.safari && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollTop() : ( scrollIsRootNode ? 0 : scroll.scrollTop() ) ) * mod)
- ),
- left: (
- pos.left // The absolute mouse position
- + this.offset.relative.left * mod // Only for relative positioned nodes: Relative offset from element to offset parent
- + this.offset.parent.left * mod // The offsetParent's offset without borders (offset + border)
- - ($.browser.safari && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollLeft() : scrollIsRootNode ? 0 : scroll.scrollLeft() ) * mod)
- )
- };
-
- },
-
- _generatePosition: function(event) {
-
- var o = this.options, scroll = this.cssPosition == 'absolute' && !(this.scrollParent[0] != document && $.ui.contains(this.scrollParent[0], this.offsetParent[0])) ? this.offsetParent : this.scrollParent, scrollIsRootNode = (/(html|body)/i).test(scroll[0].tagName);
-
- // This is another very weird special case that only happens for relative elements:
- // 1. If the css position is relative
- // 2. and the scroll parent is the document or similar to the offset parent
- // we have to refresh the relative offset during the scroll so there are no jumps
- if(this.cssPosition == 'relative' && !(this.scrollParent[0] != document && this.scrollParent[0] != this.offsetParent[0])) {
- this.offset.relative = this._getRelativeOffset();
- }
-
- var pageX = event.pageX;
- var pageY = event.pageY;
-
- /*
- * - Position constraining -
- * Constrain the position to a mix of grid, containment.
- */
-
- if(this.originalPosition) { //If we are not dragging yet, we won't check for options
-
- if(this.containment) {
- if(event.pageX - this.offset.click.left < this.containment[0]) pageX = this.containment[0] + this.offset.click.left;
- if(event.pageY - this.offset.click.top < this.containment[1]) pageY = this.containment[1] + this.offset.click.top;
- if(event.pageX - this.offset.click.left > this.containment[2]) pageX = this.containment[2] + this.offset.click.left;
- if(event.pageY - this.offset.click.top > this.containment[3]) pageY = this.containment[3] + this.offset.click.top;
- }
-
- if(o.grid) {
- var top = this.originalPageY + Math.round((pageY - this.originalPageY) / o.grid[1]) * o.grid[1];
- pageY = this.containment ? (!(top - this.offset.click.top < this.containment[1] || top - this.offset.click.top > this.containment[3]) ? top : (!(top - this.offset.click.top < this.containment[1]) ? top - o.grid[1] : top + o.grid[1])) : top;
-
- var left = this.originalPageX + Math.round((pageX - this.originalPageX) / o.grid[0]) * o.grid[0];
- pageX = this.containment ? (!(left - this.offset.click.left < this.containment[0] || left - this.offset.click.left > this.containment[2]) ? left : (!(left - this.offset.click.left < this.containment[0]) ? left - o.grid[0] : left + o.grid[0])) : left;
- }
-
- }
-
- return {
- top: (
- pageY // The absolute mouse position
- - this.offset.click.top // Click offset (relative to the element)
- - this.offset.relative.top // Only for relative positioned nodes: Relative offset from element to offset parent
- - this.offset.parent.top // The offsetParent's offset without borders (offset + border)
- + ($.browser.safari && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollTop() : ( scrollIsRootNode ? 0 : scroll.scrollTop() ) ))
- ),
- left: (
- pageX // The absolute mouse position
- - this.offset.click.left // Click offset (relative to the element)
- - this.offset.relative.left // Only for relative positioned nodes: Relative offset from element to offset parent
- - this.offset.parent.left // The offsetParent's offset without borders (offset + border)
- + ($.browser.safari && this.cssPosition == 'fixed' ? 0 : ( this.cssPosition == 'fixed' ? -this.scrollParent.scrollLeft() : scrollIsRootNode ? 0 : scroll.scrollLeft() ))
- )
- };
-
- },
-
- _rearrange: function(event, i, a, hardRefresh) {
-
- a ? a[0].appendChild(this.placeholder[0]) : i.item[0].parentNode.insertBefore(this.placeholder[0], (this.direction == 'down' ? i.item[0] : i.item[0].nextSibling));
-
- //Various things done here to improve the performance:
- // 1. we create a setTimeout, that calls refreshPositions
- // 2. on the instance, we have a counter variable, that get's higher after every append
- // 3. on the local scope, we copy the counter variable, and check in the timeout, if it's still the same
- // 4. this lets only the last addition to the timeout stack through
- this.counter = this.counter ? ++this.counter : 1;
- var self = this, counter = this.counter;
-
- window.setTimeout(function() {
- if(counter == self.counter) self.refreshPositions(!hardRefresh); //Precompute after each DOM insertion, NOT on mousemove
- },0);
-
- },
-
- _clear: function(event, noPropagation) {
-
- this.reverting = false;
- // We delay all events that have to be triggered to after the point where the placeholder has been removed and
- // everything else normalized again
- var delayedTriggers = [], self = this;
-
- // We first have to update the dom position of the actual currentItem
- // Note: don't do it if the current item is already removed (by a user), or it gets reappended (see #4088)
- if(!this._noFinalSort && this.currentItem.parent().length) this.placeholder.before(this.currentItem);
- this._noFinalSort = null;
-
- if(this.helper[0] == this.currentItem[0]) {
- for(var i in this._storedCSS) {
- if(this._storedCSS[i] == 'auto' || this._storedCSS[i] == 'static') this._storedCSS[i] = '';
- }
- this.currentItem.css(this._storedCSS).removeClass("ui-sortable-helper");
- } else {
- this.currentItem.show();
- }
-
- if(this.fromOutside && !noPropagation) delayedTriggers.push(function(event) { this._trigger("receive", event, this._uiHash(this.fromOutside)); });
- if((this.fromOutside || this.domPosition.prev != this.currentItem.prev().not(".ui-sortable-helper")[0] || this.domPosition.parent != this.currentItem.parent()[0]) && !noPropagation) delayedTriggers.push(function(event) { this._trigger("update", event, this._uiHash()); }); //Trigger update callback if the DOM position has changed
- if(!$.ui.contains(this.element[0], this.currentItem[0])) { //Node was moved out of the current element
- if(!noPropagation) delayedTriggers.push(function(event) { this._trigger("remove", event, this._uiHash()); });
- for (var i = this.containers.length - 1; i >= 0; i--){
- if($.ui.contains(this.containers[i].element[0], this.currentItem[0]) && !noPropagation) {
- delayedTriggers.push((function(c) { return function(event) { c._trigger("receive", event, this._uiHash(this)); }; }).call(this, this.containers[i]));
- delayedTriggers.push((function(c) { return function(event) { c._trigger("update", event, this._uiHash(this)); }; }).call(this, this.containers[i]));
- }
- };
- };
-
- //Post events to containers
- for (var i = this.containers.length - 1; i >= 0; i--){
- if(!noPropagation) delayedTriggers.push((function(c) { return function(event) { c._trigger("deactivate", event, this._uiHash(this)); }; }).call(this, this.containers[i]));
- if(this.containers[i].containerCache.over) {
- delayedTriggers.push((function(c) { return function(event) { c._trigger("out", event, this._uiHash(this)); }; }).call(this, this.containers[i]));
- this.containers[i].containerCache.over = 0;
- }
- }
-
- //Do what was originally in plugins
- if(this._storedCursor) $('body').css("cursor", this._storedCursor); //Reset cursor
- if(this._storedOpacity) this.helper.css("opacity", this._storedOpacity); //Reset opacity
- if(this._storedZIndex) this.helper.css("zIndex", this._storedZIndex == 'auto' ? '' : this._storedZIndex); //Reset z-index
-
- this.dragging = false;
- if(this.cancelHelperRemoval) {
- if(!noPropagation) {
- this._trigger("beforeStop", event, this._uiHash());
- for (var i=0; i < delayedTriggers.length; i++) { delayedTriggers[i].call(this, event); }; //Trigger all delayed events
- this._trigger("stop", event, this._uiHash());
- }
- return false;
- }
-
- if(!noPropagation) this._trigger("beforeStop", event, this._uiHash());
-
- //$(this.placeholder[0]).remove(); would have been the jQuery way - unfortunately, it unbinds ALL events from the original node!
- this.placeholder[0].parentNode.removeChild(this.placeholder[0]);
-
- if(this.helper[0] != this.currentItem[0]) this.helper.remove(); this.helper = null;
-
- if(!noPropagation) {
- for (var i=0; i < delayedTriggers.length; i++) { delayedTriggers[i].call(this, event); }; //Trigger all delayed events
- this._trigger("stop", event, this._uiHash());
- }
-
- this.fromOutside = false;
- return true;
-
- },
-
- _trigger: function() {
- if ($.Widget.prototype._trigger.apply(this, arguments) === false) {
- this.cancel();
- }
- },
-
- _uiHash: function(inst) {
- var self = inst || this;
- return {
- helper: self.helper,
- placeholder: self.placeholder || $([]),
- position: self.position,
- originalPosition: self.originalPosition,
- offset: self.positionAbs,
- item: self.currentItem,
- sender: inst ? inst.element : null
- };
- }
-
-});
-
-$.extend($.ui.sortable, {
- version: "1.8.14"
-});
-
-})(jQuery);
-/*
- * jQuery UI Effects 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/
- */
-;jQuery.effects || (function($, undefined) {
-
-$.effects = {};
-
-
-
-/******************************************************************************/
-/****************************** COLOR ANIMATIONS ******************************/
-/******************************************************************************/
-
-// override the animation for color styles
-$.each(['backgroundColor', 'borderBottomColor', 'borderLeftColor',
- 'borderRightColor', 'borderTopColor', 'borderColor', 'color', 'outlineColor'],
-function(i, attr) {
- $.fx.step[attr] = function(fx) {
- if (!fx.colorInit) {
- fx.start = getColor(fx.elem, attr);
- fx.end = getRGB(fx.end);
- fx.colorInit = true;
- }
-
- fx.elem.style[attr] = 'rgb(' +
- Math.max(Math.min(parseInt((fx.pos * (fx.end[0] - fx.start[0])) + fx.start[0], 10), 255), 0) + ',' +
- Math.max(Math.min(parseInt((fx.pos * (fx.end[1] - fx.start[1])) + fx.start[1], 10), 255), 0) + ',' +
- Math.max(Math.min(parseInt((fx.pos * (fx.end[2] - fx.start[2])) + fx.start[2], 10), 255), 0) + ')';
- };
-});
-
-// Color Conversion functions from highlightFade
-// By Blair Mitchelmore
-// http://jquery.offput.ca/highlightFade/
-
-// Parse strings looking for color tuples [255,255,255]
-function getRGB(color) {
- var result;
-
- // Check if we're already dealing with an array of colors
- if ( color && color.constructor == Array && color.length == 3 )
- return color;
-
- // Look for rgb(num,num,num)
- if (result = /rgb\(\s*([0-9]{1,3})\s*,\s*([0-9]{1,3})\s*,\s*([0-9]{1,3})\s*\)/.exec(color))
- return [parseInt(result[1],10), parseInt(result[2],10), parseInt(result[3],10)];
-
- // Look for rgb(num%,num%,num%)
- if (result = /rgb\(\s*([0-9]+(?:\.[0-9]+)?)\%\s*,\s*([0-9]+(?:\.[0-9]+)?)\%\s*,\s*([0-9]+(?:\.[0-9]+)?)\%\s*\)/.exec(color))
- return [parseFloat(result[1])*2.55, parseFloat(result[2])*2.55, parseFloat(result[3])*2.55];
-
- // Look for #a0b1c2
- if (result = /#([a-fA-F0-9]{2})([a-fA-F0-9]{2})([a-fA-F0-9]{2})/.exec(color))
- return [parseInt(result[1],16), parseInt(result[2],16), parseInt(result[3],16)];
-
- // Look for #fff
- if (result = /#([a-fA-F0-9])([a-fA-F0-9])([a-fA-F0-9])/.exec(color))
- return [parseInt(result[1]+result[1],16), parseInt(result[2]+result[2],16), parseInt(result[3]+result[3],16)];
-
- // Look for rgba(0, 0, 0, 0) == transparent in Safari 3
- if (result = /rgba\(0, 0, 0, 0\)/.exec(color))
- return colors['transparent'];
-
- // Otherwise, we're most likely dealing with a named color
- return colors[$.trim(color).toLowerCase()];
-}
-
-function getColor(elem, attr) {
- var color;
-
- do {
- color = $.curCSS(elem, attr);
-
- // Keep going until we find an element that has color, or we hit the body
- if ( color != '' && color != 'transparent' || $.nodeName(elem, "body") )
- break;
-
- attr = "backgroundColor";
- } while ( elem = elem.parentNode );
-
- return getRGB(color);
-};
-
-// Some named colors to work with
-// From Interface by Stefan Petre
-// http://interface.eyecon.ro/
-
-var colors = {
- aqua:[0,255,255],
- azure:[240,255,255],
- beige:[245,245,220],
- black:[0,0,0],
- blue:[0,0,255],
- brown:[165,42,42],
- cyan:[0,255,255],
- darkblue:[0,0,139],
- darkcyan:[0,139,139],
- darkgrey:[169,169,169],
- darkgreen:[0,100,0],
- darkkhaki:[189,183,107],
- darkmagenta:[139,0,139],
- darkolivegreen:[85,107,47],
- darkorange:[255,140,0],
- darkorchid:[153,50,204],
- darkred:[139,0,0],
- darksalmon:[233,150,122],
- darkviolet:[148,0,211],
- fuchsia:[255,0,255],
- gold:[255,215,0],
- green:[0,128,0],
- indigo:[75,0,130],
- khaki:[240,230,140],
- lightblue:[173,216,230],
- lightcyan:[224,255,255],
- lightgreen:[144,238,144],
- lightgrey:[211,211,211],
- lightpink:[255,182,193],
- lightyellow:[255,255,224],
- lime:[0,255,0],
- magenta:[255,0,255],
- maroon:[128,0,0],
- navy:[0,0,128],
- olive:[128,128,0],
- orange:[255,165,0],
- pink:[255,192,203],
- purple:[128,0,128],
- violet:[128,0,128],
- red:[255,0,0],
- silver:[192,192,192],
- white:[255,255,255],
- yellow:[255,255,0],
- transparent: [255,255,255]
-};
-
-
-
-/******************************************************************************/
-/****************************** CLASS ANIMATIONS ******************************/
-/******************************************************************************/
-
-var classAnimationActions = ['add', 'remove', 'toggle'],
- shorthandStyles = {
- border: 1,
- borderBottom: 1,
- borderColor: 1,
- borderLeft: 1,
- borderRight: 1,
- borderTop: 1,
- borderWidth: 1,
- margin: 1,
- padding: 1
- };
-
-function getElementStyles() {
- var style = document.defaultView
- ? document.defaultView.getComputedStyle(this, null)
- : this.currentStyle,
- newStyle = {},
- key,
- camelCase;
-
- // webkit enumerates style porperties
- if (style && style.length && style[0] && style[style[0]]) {
- var len = style.length;
- while (len--) {
- key = style[len];
- if (typeof style[key] == 'string') {
- camelCase = key.replace(/\-(\w)/g, function(all, letter){
- return letter.toUpperCase();
- });
- newStyle[camelCase] = style[key];
- }
- }
- } else {
- for (key in style) {
- if (typeof style[key] === 'string') {
- newStyle[key] = style[key];
- }
- }
- }
-
- return newStyle;
-}
-
-function filterStyles(styles) {
- var name, value;
- for (name in styles) {
- value = styles[name];
- if (
- // ignore null and undefined values
- value == null ||
- // ignore functions (when does this occur?)
- $.isFunction(value) ||
- // shorthand styles that need to be expanded
- name in shorthandStyles ||
- // ignore scrollbars (break in IE)
- (/scrollbar/).test(name) ||
-
- // only colors or values that can be converted to numbers
- (!(/color/i).test(name) && isNaN(parseFloat(value)))
- ) {
- delete styles[name];
- }
- }
-
- return styles;
-}
-
-function styleDifference(oldStyle, newStyle) {
- var diff = { _: 0 }, // http://dev.jquery.com/ticket/5459
- name;
-
- for (name in newStyle) {
- if (oldStyle[name] != newStyle[name]) {
- diff[name] = newStyle[name];
- }
- }
-
- return diff;
-}
-
-$.effects.animateClass = function(value, duration, easing, callback) {
- if ($.isFunction(easing)) {
- callback = easing;
- easing = null;
- }
-
- return this.queue(function() {
- var that = $(this),
- originalStyleAttr = that.attr('style') || ' ',
- originalStyle = filterStyles(getElementStyles.call(this)),
- newStyle,
- className = that.attr('class');
-
- $.each(classAnimationActions, function(i, action) {
- if (value[action]) {
- that[action + 'Class'](value[action]);
- }
- });
- newStyle = filterStyles(getElementStyles.call(this));
- that.attr('class', className);
-
- that.animate(styleDifference(originalStyle, newStyle), {
- queue: false,
- duration: duration,
- easing: easing,
- complete: function() {
- $.each(classAnimationActions, function(i, action) {
- if (value[action]) { that[action + 'Class'](value[action]); }
- });
- // work around bug in IE by clearing the cssText before setting it
- if (typeof that.attr('style') == 'object') {
- that.attr('style').cssText = '';
- that.attr('style').cssText = originalStyleAttr;
- } else {
- that.attr('style', originalStyleAttr);
- }
- if (callback) { callback.apply(this, arguments); }
- $.dequeue( this );
- }
- });
- });
-};
-
-$.fn.extend({
- _addClass: $.fn.addClass,
- addClass: function(classNames, speed, easing, callback) {
- return speed ? $.effects.animateClass.apply(this, [{ add: classNames },speed,easing,callback]) : this._addClass(classNames);
- },
-
- _removeClass: $.fn.removeClass,
- removeClass: function(classNames,speed,easing,callback) {
- return speed ? $.effects.animateClass.apply(this, [{ remove: classNames },speed,easing,callback]) : this._removeClass(classNames);
- },
-
- _toggleClass: $.fn.toggleClass,
- toggleClass: function(classNames, force, speed, easing, callback) {
- if ( typeof force == "boolean" || force === undefined ) {
- if ( !speed ) {
- // without speed parameter;
- return this._toggleClass(classNames, force);
- } else {
- return $.effects.animateClass.apply(this, [(force?{add:classNames}:{remove:classNames}),speed,easing,callback]);
- }
- } else {
- // without switch parameter;
- return $.effects.animateClass.apply(this, [{ toggle: classNames },force,speed,easing]);
- }
- },
-
- switchClass: function(remove,add,speed,easing,callback) {
- return $.effects.animateClass.apply(this, [{ add: add, remove: remove },speed,easing,callback]);
- }
-});
-
-
-
-/******************************************************************************/
-/*********************************** EFFECTS **********************************/
-/******************************************************************************/
-
-$.extend($.effects, {
- version: "1.8.14",
-
- // Saves a set of properties in a data storage
- save: function(element, set) {
- for(var i=0; i < set.length; i++) {
- if(set[i] !== null) element.data("ec.storage."+set[i], element[0].style[set[i]]);
- }
- },
-
- // Restores a set of previously saved properties from a data storage
- restore: function(element, set) {
- for(var i=0; i < set.length; i++) {
- if(set[i] !== null) element.css(set[i], element.data("ec.storage."+set[i]));
- }
- },
-
- setMode: function(el, mode) {
- if (mode == 'toggle') mode = el.is(':hidden') ? 'show' : 'hide'; // Set for toggle
- return mode;
- },
-
- getBaseline: function(origin, original) { // Translates a [top,left] array into a baseline value
- // this should be a little more flexible in the future to handle a string & hash
- var y, x;
- switch (origin[0]) {
- case 'top': y = 0; break;
- case 'middle': y = 0.5; break;
- case 'bottom': y = 1; break;
- default: y = origin[0] / original.height;
- };
- switch (origin[1]) {
- case 'left': x = 0; break;
- case 'center': x = 0.5; break;
- case 'right': x = 1; break;
- default: x = origin[1] / original.width;
- };
- return {x: x, y: y};
- },
-
- // Wraps the element around a wrapper that copies position properties
- createWrapper: function(element) {
-
- // if the element is already wrapped, return it
- if (element.parent().is('.ui-effects-wrapper')) {
- return element.parent();
- }
-
- // wrap the element
- var props = {
- width: element.outerWidth(true),
- height: element.outerHeight(true),
- 'float': element.css('float')
- },
- wrapper = $('')
- .addClass('ui-effects-wrapper')
- .css({
- fontSize: '100%',
- background: 'transparent',
- border: 'none',
- margin: 0,
- padding: 0
- });
-
- element.wrap(wrapper);
- wrapper = element.parent(); //Hotfix for jQuery 1.4 since some change in wrap() seems to actually loose the reference to the wrapped element
-
- // transfer positioning properties to the wrapper
- if (element.css('position') == 'static') {
- wrapper.css({ position: 'relative' });
- element.css({ position: 'relative' });
- } else {
- $.extend(props, {
- position: element.css('position'),
- zIndex: element.css('z-index')
- });
- $.each(['top', 'left', 'bottom', 'right'], function(i, pos) {
- props[pos] = element.css(pos);
- if (isNaN(parseInt(props[pos], 10))) {
- props[pos] = 'auto';
- }
- });
- element.css({position: 'relative', top: 0, left: 0, right: 'auto', bottom: 'auto' });
- }
-
- return wrapper.css(props).show();
- },
-
- removeWrapper: function(element) {
- if (element.parent().is('.ui-effects-wrapper'))
- return element.parent().replaceWith(element);
- return element;
- },
-
- setTransition: function(element, list, factor, value) {
- value = value || {};
- $.each(list, function(i, x){
- unit = element.cssUnit(x);
- if (unit[0] > 0) value[x] = unit[0] * factor + unit[1];
- });
- return value;
- }
-});
-
-
-function _normalizeArguments(effect, options, speed, callback) {
- // shift params for method overloading
- if (typeof effect == 'object') {
- callback = options;
- speed = null;
- options = effect;
- effect = options.effect;
- }
- if ($.isFunction(options)) {
- callback = options;
- speed = null;
- options = {};
- }
- if (typeof options == 'number' || $.fx.speeds[options]) {
- callback = speed;
- speed = options;
- options = {};
- }
- if ($.isFunction(speed)) {
- callback = speed;
- speed = null;
- }
-
- options = options || {};
-
- speed = speed || options.duration;
- speed = $.fx.off ? 0 : typeof speed == 'number'
- ? speed : speed in $.fx.speeds ? $.fx.speeds[speed] : $.fx.speeds._default;
-
- callback = callback || options.complete;
-
- return [effect, options, speed, callback];
-}
-
-function standardSpeed( speed ) {
- // valid standard speeds
- if ( !speed || typeof speed === "number" || $.fx.speeds[ speed ] ) {
- return true;
- }
-
- // invalid strings - treat as "normal" speed
- if ( typeof speed === "string" && !$.effects[ speed ] ) {
- return true;
- }
-
- return false;
-}
-
-$.fn.extend({
- effect: function(effect, options, speed, callback) {
- var args = _normalizeArguments.apply(this, arguments),
- // TODO: make effects take actual parameters instead of a hash
- args2 = {
- options: args[1],
- duration: args[2],
- callback: args[3]
- },
- mode = args2.options.mode,
- effectMethod = $.effects[effect];
-
- if ( $.fx.off || !effectMethod ) {
- // delegate to the original method (e.g., .show()) if possible
- if ( mode ) {
- return this[ mode ]( args2.duration, args2.callback );
- } else {
- return this.each(function() {
- if ( args2.callback ) {
- args2.callback.call( this );
- }
- });
- }
- }
-
- return effectMethod.call(this, args2);
- },
-
- _show: $.fn.show,
- show: function(speed) {
- if ( standardSpeed( speed ) ) {
- return this._show.apply(this, arguments);
- } else {
- var args = _normalizeArguments.apply(this, arguments);
- args[1].mode = 'show';
- return this.effect.apply(this, args);
- }
- },
-
- _hide: $.fn.hide,
- hide: function(speed) {
- if ( standardSpeed( speed ) ) {
- return this._hide.apply(this, arguments);
- } else {
- var args = _normalizeArguments.apply(this, arguments);
- args[1].mode = 'hide';
- return this.effect.apply(this, args);
- }
- },
-
- // jQuery core overloads toggle and creates _toggle
- __toggle: $.fn.toggle,
- toggle: function(speed) {
- if ( standardSpeed( speed ) || typeof speed === "boolean" || $.isFunction( speed ) ) {
- return this.__toggle.apply(this, arguments);
- } else {
- var args = _normalizeArguments.apply(this, arguments);
- args[1].mode = 'toggle';
- return this.effect.apply(this, args);
- }
- },
-
- // helper functions
- cssUnit: function(key) {
- var style = this.css(key), val = [];
- $.each( ['em','px','%','pt'], function(i, unit){
- if(style.indexOf(unit) > 0)
- val = [parseFloat(style), unit];
- });
- return val;
- }
-});
-
-
-
-/******************************************************************************/
-/*********************************** EASING ***********************************/
-/******************************************************************************/
-
-/*
- * jQuery Easing v1.3 - http://gsgd.co.uk/sandbox/jquery/easing/
- *
- * Uses the built in easing capabilities added In jQuery 1.1
- * to offer multiple easing options
- *
- * TERMS OF USE - jQuery Easing
- *
- * Open source under the BSD License.
- *
- * Copyright 2008 George McGinley Smith
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice, this list of
- * conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice, this list
- * of conditions and the following disclaimer in the documentation and/or other materials
- * provided with the distribution.
- *
- * Neither the name of the author nor the names of contributors may be used to endorse
- * or promote products derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
- * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- *
-*/
-
-// t: current time, b: begInnIng value, c: change In value, d: duration
-$.easing.jswing = $.easing.swing;
-
-$.extend($.easing,
-{
- def: 'easeOutQuad',
- swing: function (x, t, b, c, d) {
- //alert($.easing.default);
- return $.easing[$.easing.def](x, t, b, c, d);
- },
- easeInQuad: function (x, t, b, c, d) {
- return c*(t/=d)*t + b;
- },
- easeOutQuad: function (x, t, b, c, d) {
- return -c *(t/=d)*(t-2) + b;
- },
- easeInOutQuad: function (x, t, b, c, d) {
- if ((t/=d/2) < 1) return c/2*t*t + b;
- return -c/2 * ((--t)*(t-2) - 1) + b;
- },
- easeInCubic: function (x, t, b, c, d) {
- return c*(t/=d)*t*t + b;
- },
- easeOutCubic: function (x, t, b, c, d) {
- return c*((t=t/d-1)*t*t + 1) + b;
- },
- easeInOutCubic: function (x, t, b, c, d) {
- if ((t/=d/2) < 1) return c/2*t*t*t + b;
- return c/2*((t-=2)*t*t + 2) + b;
- },
- easeInQuart: function (x, t, b, c, d) {
- return c*(t/=d)*t*t*t + b;
- },
- easeOutQuart: function (x, t, b, c, d) {
- return -c * ((t=t/d-1)*t*t*t - 1) + b;
- },
- easeInOutQuart: function (x, t, b, c, d) {
- if ((t/=d/2) < 1) return c/2*t*t*t*t + b;
- return -c/2 * ((t-=2)*t*t*t - 2) + b;
- },
- easeInQuint: function (x, t, b, c, d) {
- return c*(t/=d)*t*t*t*t + b;
- },
- easeOutQuint: function (x, t, b, c, d) {
- return c*((t=t/d-1)*t*t*t*t + 1) + b;
- },
- easeInOutQuint: function (x, t, b, c, d) {
- if ((t/=d/2) < 1) return c/2*t*t*t*t*t + b;
- return c/2*((t-=2)*t*t*t*t + 2) + b;
- },
- easeInSine: function (x, t, b, c, d) {
- return -c * Math.cos(t/d * (Math.PI/2)) + c + b;
- },
- easeOutSine: function (x, t, b, c, d) {
- return c * Math.sin(t/d * (Math.PI/2)) + b;
- },
- easeInOutSine: function (x, t, b, c, d) {
- return -c/2 * (Math.cos(Math.PI*t/d) - 1) + b;
- },
- easeInExpo: function (x, t, b, c, d) {
- return (t==0) ? b : c * Math.pow(2, 10 * (t/d - 1)) + b;
- },
- easeOutExpo: function (x, t, b, c, d) {
- return (t==d) ? b+c : c * (-Math.pow(2, -10 * t/d) + 1) + b;
- },
- easeInOutExpo: function (x, t, b, c, d) {
- if (t==0) return b;
- if (t==d) return b+c;
- if ((t/=d/2) < 1) return c/2 * Math.pow(2, 10 * (t - 1)) + b;
- return c/2 * (-Math.pow(2, -10 * --t) + 2) + b;
- },
- easeInCirc: function (x, t, b, c, d) {
- return -c * (Math.sqrt(1 - (t/=d)*t) - 1) + b;
- },
- easeOutCirc: function (x, t, b, c, d) {
- return c * Math.sqrt(1 - (t=t/d-1)*t) + b;
- },
- easeInOutCirc: function (x, t, b, c, d) {
- if ((t/=d/2) < 1) return -c/2 * (Math.sqrt(1 - t*t) - 1) + b;
- return c/2 * (Math.sqrt(1 - (t-=2)*t) + 1) + b;
- },
- easeInElastic: function (x, t, b, c, d) {
- var s=1.70158;var p=0;var a=c;
- if (t==0) return b; if ((t/=d)==1) return b+c; if (!p) p=d*.3;
- if (a < Math.abs(c)) { a=c; var s=p/4; }
- else var s = p/(2*Math.PI) * Math.asin (c/a);
- return -(a*Math.pow(2,10*(t-=1)) * Math.sin( (t*d-s)*(2*Math.PI)/p )) + b;
- },
- easeOutElastic: function (x, t, b, c, d) {
- var s=1.70158;var p=0;var a=c;
- if (t==0) return b; if ((t/=d)==1) return b+c; if (!p) p=d*.3;
- if (a < Math.abs(c)) { a=c; var s=p/4; }
- else var s = p/(2*Math.PI) * Math.asin (c/a);
- return a*Math.pow(2,-10*t) * Math.sin( (t*d-s)*(2*Math.PI)/p ) + c + b;
- },
- easeInOutElastic: function (x, t, b, c, d) {
- var s=1.70158;var p=0;var a=c;
- if (t==0) return b; if ((t/=d/2)==2) return b+c; if (!p) p=d*(.3*1.5);
- if (a < Math.abs(c)) { a=c; var s=p/4; }
- else var s = p/(2*Math.PI) * Math.asin (c/a);
- if (t < 1) return -.5*(a*Math.pow(2,10*(t-=1)) * Math.sin( (t*d-s)*(2*Math.PI)/p )) + b;
- return a*Math.pow(2,-10*(t-=1)) * Math.sin( (t*d-s)*(2*Math.PI)/p )*.5 + c + b;
- },
- easeInBack: function (x, t, b, c, d, s) {
- if (s == undefined) s = 1.70158;
- return c*(t/=d)*t*((s+1)*t - s) + b;
- },
- easeOutBack: function (x, t, b, c, d, s) {
- if (s == undefined) s = 1.70158;
- return c*((t=t/d-1)*t*((s+1)*t + s) + 1) + b;
- },
- easeInOutBack: function (x, t, b, c, d, s) {
- if (s == undefined) s = 1.70158;
- if ((t/=d/2) < 1) return c/2*(t*t*(((s*=(1.525))+1)*t - s)) + b;
- return c/2*((t-=2)*t*(((s*=(1.525))+1)*t + s) + 2) + b;
- },
- easeInBounce: function (x, t, b, c, d) {
- return c - $.easing.easeOutBounce (x, d-t, 0, c, d) + b;
- },
- easeOutBounce: function (x, t, b, c, d) {
- if ((t/=d) < (1/2.75)) {
- return c*(7.5625*t*t) + b;
- } else if (t < (2/2.75)) {
- return c*(7.5625*(t-=(1.5/2.75))*t + .75) + b;
- } else if (t < (2.5/2.75)) {
- return c*(7.5625*(t-=(2.25/2.75))*t + .9375) + b;
- } else {
- return c*(7.5625*(t-=(2.625/2.75))*t + .984375) + b;
- }
- },
- easeInOutBounce: function (x, t, b, c, d) {
- if (t < d/2) return $.easing.easeInBounce (x, t*2, 0, c, d) * .5 + b;
- return $.easing.easeOutBounce (x, t*2-d, 0, c, d) * .5 + c*.5 + b;
- }
-});
-
-/*
- *
- * TERMS OF USE - EASING EQUATIONS
- *
- * Open source under the BSD License.
- *
- * Copyright 2001 Robert Penner
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice, this list of
- * conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice, this list
- * of conditions and the following disclaimer in the documentation and/or other materials
- * provided with the distribution.
- *
- * Neither the name of the author nor the names of contributors may be used to endorse
- * or promote products derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
- * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
-
-})(jQuery);
-/*
- * jQuery UI Effects Blind 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Blind
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.blind = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'hide'); // Set Mode
- var direction = o.options.direction || 'vertical'; // Default direction
-
- // Adjust
- $.effects.save(el, props); el.show(); // Save & Show
- var wrapper = $.effects.createWrapper(el).css({overflow:'hidden'}); // Create Wrapper
- var ref = (direction == 'vertical') ? 'height' : 'width';
- var distance = (direction == 'vertical') ? wrapper.height() : wrapper.width();
- if(mode == 'show') wrapper.css(ref, 0); // Shift
-
- // Animation
- var animation = {};
- animation[ref] = mode == 'show' ? distance : 0;
-
- // Animate
- wrapper.animate(animation, o.duration, o.options.easing, function() {
- if(mode == 'hide') el.hide(); // Hide
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(el[0], arguments); // Callback
- el.dequeue();
- });
-
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Bounce 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Bounce
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.bounce = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'effect'); // Set Mode
- var direction = o.options.direction || 'up'; // Default direction
- var distance = o.options.distance || 20; // Default distance
- var times = o.options.times || 5; // Default # of times
- var speed = o.duration || 250; // Default speed per bounce
- if (/show|hide/.test(mode)) props.push('opacity'); // Avoid touching opacity to prevent clearType and PNG issues in IE
-
- // Adjust
- $.effects.save(el, props); el.show(); // Save & Show
- $.effects.createWrapper(el); // Create Wrapper
- var ref = (direction == 'up' || direction == 'down') ? 'top' : 'left';
- var motion = (direction == 'up' || direction == 'left') ? 'pos' : 'neg';
- var distance = o.options.distance || (ref == 'top' ? el.outerHeight({margin:true}) / 3 : el.outerWidth({margin:true}) / 3);
- if (mode == 'show') el.css('opacity', 0).css(ref, motion == 'pos' ? -distance : distance); // Shift
- if (mode == 'hide') distance = distance / (times * 2);
- if (mode != 'hide') times--;
-
- // Animate
- if (mode == 'show') { // Show Bounce
- var animation = {opacity: 1};
- animation[ref] = (motion == 'pos' ? '+=' : '-=') + distance;
- el.animate(animation, speed / 2, o.options.easing);
- distance = distance / 2;
- times--;
- };
- for (var i = 0; i < times; i++) { // Bounces
- var animation1 = {}, animation2 = {};
- animation1[ref] = (motion == 'pos' ? '-=' : '+=') + distance;
- animation2[ref] = (motion == 'pos' ? '+=' : '-=') + distance;
- el.animate(animation1, speed / 2, o.options.easing).animate(animation2, speed / 2, o.options.easing);
- distance = (mode == 'hide') ? distance * 2 : distance / 2;
- };
- if (mode == 'hide') { // Last Bounce
- var animation = {opacity: 0};
- animation[ref] = (motion == 'pos' ? '-=' : '+=') + distance;
- el.animate(animation, speed / 2, o.options.easing, function(){
- el.hide(); // Hide
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(this, arguments); // Callback
- });
- } else {
- var animation1 = {}, animation2 = {};
- animation1[ref] = (motion == 'pos' ? '-=' : '+=') + distance;
- animation2[ref] = (motion == 'pos' ? '+=' : '-=') + distance;
- el.animate(animation1, speed / 2, o.options.easing).animate(animation2, speed / 2, o.options.easing, function(){
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(this, arguments); // Callback
- });
- };
- el.queue('fx', function() { el.dequeue(); });
- el.dequeue();
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Clip 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Clip
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.clip = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right','height','width'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'hide'); // Set Mode
- var direction = o.options.direction || 'vertical'; // Default direction
-
- // Adjust
- $.effects.save(el, props); el.show(); // Save & Show
- var wrapper = $.effects.createWrapper(el).css({overflow:'hidden'}); // Create Wrapper
- var animate = el[0].tagName == 'IMG' ? wrapper : el;
- var ref = {
- size: (direction == 'vertical') ? 'height' : 'width',
- position: (direction == 'vertical') ? 'top' : 'left'
- };
- var distance = (direction == 'vertical') ? animate.height() : animate.width();
- if(mode == 'show') { animate.css(ref.size, 0); animate.css(ref.position, distance / 2); } // Shift
-
- // Animation
- var animation = {};
- animation[ref.size] = mode == 'show' ? distance : 0;
- animation[ref.position] = mode == 'show' ? 0 : distance / 2;
-
- // Animate
- animate.animate(animation, { queue: false, duration: o.duration, easing: o.options.easing, complete: function() {
- if(mode == 'hide') el.hide(); // Hide
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(el[0], arguments); // Callback
- el.dequeue();
- }});
-
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Drop 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Drop
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.drop = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right','opacity'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'hide'); // Set Mode
- var direction = o.options.direction || 'left'; // Default Direction
-
- // Adjust
- $.effects.save(el, props); el.show(); // Save & Show
- $.effects.createWrapper(el); // Create Wrapper
- var ref = (direction == 'up' || direction == 'down') ? 'top' : 'left';
- var motion = (direction == 'up' || direction == 'left') ? 'pos' : 'neg';
- var distance = o.options.distance || (ref == 'top' ? el.outerHeight({margin:true}) / 2 : el.outerWidth({margin:true}) / 2);
- if (mode == 'show') el.css('opacity', 0).css(ref, motion == 'pos' ? -distance : distance); // Shift
-
- // Animation
- var animation = {opacity: mode == 'show' ? 1 : 0};
- animation[ref] = (mode == 'show' ? (motion == 'pos' ? '+=' : '-=') : (motion == 'pos' ? '-=' : '+=')) + distance;
-
- // Animate
- el.animate(animation, { queue: false, duration: o.duration, easing: o.options.easing, complete: function() {
- if(mode == 'hide') el.hide(); // Hide
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(this, arguments); // Callback
- el.dequeue();
- }});
-
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Explode 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Explode
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.explode = function(o) {
-
- return this.queue(function() {
-
- var rows = o.options.pieces ? Math.round(Math.sqrt(o.options.pieces)) : 3;
- var cells = o.options.pieces ? Math.round(Math.sqrt(o.options.pieces)) : 3;
-
- o.options.mode = o.options.mode == 'toggle' ? ($(this).is(':visible') ? 'hide' : 'show') : o.options.mode;
- var el = $(this).show().css('visibility', 'hidden');
- var offset = el.offset();
-
- //Substract the margins - not fixing the problem yet.
- offset.top -= parseInt(el.css("marginTop"),10) || 0;
- offset.left -= parseInt(el.css("marginLeft"),10) || 0;
-
- var width = el.outerWidth(true);
- var height = el.outerHeight(true);
-
- for(var i=0;i')
- .css({
- position: 'absolute',
- visibility: 'visible',
- left: -j*(width/cells),
- top: -i*(height/rows)
- })
- .parent()
- .addClass('ui-effects-explode')
- .css({
- position: 'absolute',
- overflow: 'hidden',
- width: width/cells,
- height: height/rows,
- left: offset.left + j*(width/cells) + (o.options.mode == 'show' ? (j-Math.floor(cells/2))*(width/cells) : 0),
- top: offset.top + i*(height/rows) + (o.options.mode == 'show' ? (i-Math.floor(rows/2))*(height/rows) : 0),
- opacity: o.options.mode == 'show' ? 0 : 1
- }).animate({
- left: offset.left + j*(width/cells) + (o.options.mode == 'show' ? 0 : (j-Math.floor(cells/2))*(width/cells)),
- top: offset.top + i*(height/rows) + (o.options.mode == 'show' ? 0 : (i-Math.floor(rows/2))*(height/rows)),
- opacity: o.options.mode == 'show' ? 1 : 0
- }, o.duration || 500);
- }
- }
-
- // Set a timeout, to call the callback approx. when the other animations have finished
- setTimeout(function() {
-
- o.options.mode == 'show' ? el.css({ visibility: 'visible' }) : el.css({ visibility: 'visible' }).hide();
- if(o.callback) o.callback.apply(el[0]); // Callback
- el.dequeue();
-
- $('div.ui-effects-explode').remove();
-
- }, o.duration || 500);
-
-
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Fade 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Fade
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.fade = function(o) {
- return this.queue(function() {
- var elem = $(this),
- mode = $.effects.setMode(elem, o.options.mode || 'hide');
-
- elem.animate({ opacity: mode }, {
- queue: false,
- duration: o.duration,
- easing: o.options.easing,
- complete: function() {
- (o.callback && o.callback.apply(this, arguments));
- elem.dequeue();
- }
- });
- });
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Fold 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Fold
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.fold = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'hide'); // Set Mode
- var size = o.options.size || 15; // Default fold size
- var horizFirst = !(!o.options.horizFirst); // Ensure a boolean value
- var duration = o.duration ? o.duration / 2 : $.fx.speeds._default / 2;
-
- // Adjust
- $.effects.save(el, props); el.show(); // Save & Show
- var wrapper = $.effects.createWrapper(el).css({overflow:'hidden'}); // Create Wrapper
- var widthFirst = ((mode == 'show') != horizFirst);
- var ref = widthFirst ? ['width', 'height'] : ['height', 'width'];
- var distance = widthFirst ? [wrapper.width(), wrapper.height()] : [wrapper.height(), wrapper.width()];
- var percent = /([0-9]+)%/.exec(size);
- if(percent) size = parseInt(percent[1],10) / 100 * distance[mode == 'hide' ? 0 : 1];
- if(mode == 'show') wrapper.css(horizFirst ? {height: 0, width: size} : {height: size, width: 0}); // Shift
-
- // Animation
- var animation1 = {}, animation2 = {};
- animation1[ref[0]] = mode == 'show' ? distance[0] : size;
- animation2[ref[1]] = mode == 'show' ? distance[1] : 0;
-
- // Animate
- wrapper.animate(animation1, duration, o.options.easing)
- .animate(animation2, duration, o.options.easing, function() {
- if(mode == 'hide') el.hide(); // Hide
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(el[0], arguments); // Callback
- el.dequeue();
- });
-
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Highlight 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Highlight
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.highlight = function(o) {
- return this.queue(function() {
- var elem = $(this),
- props = ['backgroundImage', 'backgroundColor', 'opacity'],
- mode = $.effects.setMode(elem, o.options.mode || 'show'),
- animation = {
- backgroundColor: elem.css('backgroundColor')
- };
-
- if (mode == 'hide') {
- animation.opacity = 0;
- }
-
- $.effects.save(elem, props);
- elem
- .show()
- .css({
- backgroundImage: 'none',
- backgroundColor: o.options.color || '#ffff99'
- })
- .animate(animation, {
- queue: false,
- duration: o.duration,
- easing: o.options.easing,
- complete: function() {
- (mode == 'hide' && elem.hide());
- $.effects.restore(elem, props);
- (mode == 'show' && !$.support.opacity && this.style.removeAttribute('filter'));
- (o.callback && o.callback.apply(this, arguments));
- elem.dequeue();
- }
- });
- });
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Pulsate 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Pulsate
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.pulsate = function(o) {
- return this.queue(function() {
- var elem = $(this),
- mode = $.effects.setMode(elem, o.options.mode || 'show');
- times = ((o.options.times || 5) * 2) - 1;
- duration = o.duration ? o.duration / 2 : $.fx.speeds._default / 2,
- isVisible = elem.is(':visible'),
- animateTo = 0;
-
- if (!isVisible) {
- elem.css('opacity', 0).show();
- animateTo = 1;
- }
-
- if ((mode == 'hide' && isVisible) || (mode == 'show' && !isVisible)) {
- times--;
- }
-
- for (var i = 0; i < times; i++) {
- elem.animate({ opacity: animateTo }, duration, o.options.easing);
- animateTo = (animateTo + 1) % 2;
- }
-
- elem.animate({ opacity: animateTo }, duration, o.options.easing, function() {
- if (animateTo == 0) {
- elem.hide();
- }
- (o.callback && o.callback.apply(this, arguments));
- });
-
- elem
- .queue('fx', function() { elem.dequeue(); })
- .dequeue();
- });
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Scale 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Scale
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.puff = function(o) {
- return this.queue(function() {
- var elem = $(this),
- mode = $.effects.setMode(elem, o.options.mode || 'hide'),
- percent = parseInt(o.options.percent, 10) || 150,
- factor = percent / 100,
- original = { height: elem.height(), width: elem.width() };
-
- $.extend(o.options, {
- fade: true,
- mode: mode,
- percent: mode == 'hide' ? percent : 100,
- from: mode == 'hide'
- ? original
- : {
- height: original.height * factor,
- width: original.width * factor
- }
- });
-
- elem.effect('scale', o.options, o.duration, o.callback);
- elem.dequeue();
- });
-};
-
-$.effects.scale = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this);
-
- // Set options
- var options = $.extend(true, {}, o.options);
- var mode = $.effects.setMode(el, o.options.mode || 'effect'); // Set Mode
- var percent = parseInt(o.options.percent,10) || (parseInt(o.options.percent,10) == 0 ? 0 : (mode == 'hide' ? 0 : 100)); // Set default scaling percent
- var direction = o.options.direction || 'both'; // Set default axis
- var origin = o.options.origin; // The origin of the scaling
- if (mode != 'effect') { // Set default origin and restore for show/hide
- options.origin = origin || ['middle','center'];
- options.restore = true;
- }
- var original = {height: el.height(), width: el.width()}; // Save original
- el.from = o.options.from || (mode == 'show' ? {height: 0, width: 0} : original); // Default from state
-
- // Adjust
- var factor = { // Set scaling factor
- y: direction != 'horizontal' ? (percent / 100) : 1,
- x: direction != 'vertical' ? (percent / 100) : 1
- };
- el.to = {height: original.height * factor.y, width: original.width * factor.x}; // Set to state
-
- if (o.options.fade) { // Fade option to support puff
- if (mode == 'show') {el.from.opacity = 0; el.to.opacity = 1;};
- if (mode == 'hide') {el.from.opacity = 1; el.to.opacity = 0;};
- };
-
- // Animation
- options.from = el.from; options.to = el.to; options.mode = mode;
-
- // Animate
- el.effect('size', options, o.duration, o.callback);
- el.dequeue();
- });
-
-};
-
-$.effects.size = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right','width','height','overflow','opacity'];
- var props1 = ['position','top','bottom','left','right','overflow','opacity']; // Always restore
- var props2 = ['width','height','overflow']; // Copy for children
- var cProps = ['fontSize'];
- var vProps = ['borderTopWidth', 'borderBottomWidth', 'paddingTop', 'paddingBottom'];
- var hProps = ['borderLeftWidth', 'borderRightWidth', 'paddingLeft', 'paddingRight'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'effect'); // Set Mode
- var restore = o.options.restore || false; // Default restore
- var scale = o.options.scale || 'both'; // Default scale mode
- var origin = o.options.origin; // The origin of the sizing
- var original = {height: el.height(), width: el.width()}; // Save original
- el.from = o.options.from || original; // Default from state
- el.to = o.options.to || original; // Default to state
- // Adjust
- if (origin) { // Calculate baseline shifts
- var baseline = $.effects.getBaseline(origin, original);
- el.from.top = (original.height - el.from.height) * baseline.y;
- el.from.left = (original.width - el.from.width) * baseline.x;
- el.to.top = (original.height - el.to.height) * baseline.y;
- el.to.left = (original.width - el.to.width) * baseline.x;
- };
- var factor = { // Set scaling factor
- from: {y: el.from.height / original.height, x: el.from.width / original.width},
- to: {y: el.to.height / original.height, x: el.to.width / original.width}
- };
- if (scale == 'box' || scale == 'both') { // Scale the css box
- if (factor.from.y != factor.to.y) { // Vertical props scaling
- props = props.concat(vProps);
- el.from = $.effects.setTransition(el, vProps, factor.from.y, el.from);
- el.to = $.effects.setTransition(el, vProps, factor.to.y, el.to);
- };
- if (factor.from.x != factor.to.x) { // Horizontal props scaling
- props = props.concat(hProps);
- el.from = $.effects.setTransition(el, hProps, factor.from.x, el.from);
- el.to = $.effects.setTransition(el, hProps, factor.to.x, el.to);
- };
- };
- if (scale == 'content' || scale == 'both') { // Scale the content
- if (factor.from.y != factor.to.y) { // Vertical props scaling
- props = props.concat(cProps);
- el.from = $.effects.setTransition(el, cProps, factor.from.y, el.from);
- el.to = $.effects.setTransition(el, cProps, factor.to.y, el.to);
- };
- };
- $.effects.save(el, restore ? props : props1); el.show(); // Save & Show
- $.effects.createWrapper(el); // Create Wrapper
- el.css('overflow','hidden').css(el.from); // Shift
-
- // Animate
- if (scale == 'content' || scale == 'both') { // Scale the children
- vProps = vProps.concat(['marginTop','marginBottom']).concat(cProps); // Add margins/font-size
- hProps = hProps.concat(['marginLeft','marginRight']); // Add margins
- props2 = props.concat(vProps).concat(hProps); // Concat
- el.find("*[width]").each(function(){
- child = $(this);
- if (restore) $.effects.save(child, props2);
- var c_original = {height: child.height(), width: child.width()}; // Save original
- child.from = {height: c_original.height * factor.from.y, width: c_original.width * factor.from.x};
- child.to = {height: c_original.height * factor.to.y, width: c_original.width * factor.to.x};
- if (factor.from.y != factor.to.y) { // Vertical props scaling
- child.from = $.effects.setTransition(child, vProps, factor.from.y, child.from);
- child.to = $.effects.setTransition(child, vProps, factor.to.y, child.to);
- };
- if (factor.from.x != factor.to.x) { // Horizontal props scaling
- child.from = $.effects.setTransition(child, hProps, factor.from.x, child.from);
- child.to = $.effects.setTransition(child, hProps, factor.to.x, child.to);
- };
- child.css(child.from); // Shift children
- child.animate(child.to, o.duration, o.options.easing, function(){
- if (restore) $.effects.restore(child, props2); // Restore children
- }); // Animate children
- });
- };
-
- // Animate
- el.animate(el.to, { queue: false, duration: o.duration, easing: o.options.easing, complete: function() {
- if (el.to.opacity === 0) {
- el.css('opacity', el.from.opacity);
- }
- if(mode == 'hide') el.hide(); // Hide
- $.effects.restore(el, restore ? props : props1); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(this, arguments); // Callback
- el.dequeue();
- }});
-
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Shake 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Shake
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.shake = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'effect'); // Set Mode
- var direction = o.options.direction || 'left'; // Default direction
- var distance = o.options.distance || 20; // Default distance
- var times = o.options.times || 3; // Default # of times
- var speed = o.duration || o.options.duration || 140; // Default speed per shake
-
- // Adjust
- $.effects.save(el, props); el.show(); // Save & Show
- $.effects.createWrapper(el); // Create Wrapper
- var ref = (direction == 'up' || direction == 'down') ? 'top' : 'left';
- var motion = (direction == 'up' || direction == 'left') ? 'pos' : 'neg';
-
- // Animation
- var animation = {}, animation1 = {}, animation2 = {};
- animation[ref] = (motion == 'pos' ? '-=' : '+=') + distance;
- animation1[ref] = (motion == 'pos' ? '+=' : '-=') + distance * 2;
- animation2[ref] = (motion == 'pos' ? '-=' : '+=') + distance * 2;
-
- // Animate
- el.animate(animation, speed, o.options.easing);
- for (var i = 1; i < times; i++) { // Shakes
- el.animate(animation1, speed, o.options.easing).animate(animation2, speed, o.options.easing);
- };
- el.animate(animation1, speed, o.options.easing).
- animate(animation, speed / 2, o.options.easing, function(){ // Last shake
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(this, arguments); // Callback
- });
- el.queue('fx', function() { el.dequeue(); });
- el.dequeue();
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Slide 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Slide
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.slide = function(o) {
-
- return this.queue(function() {
-
- // Create element
- var el = $(this), props = ['position','top','bottom','left','right'];
-
- // Set options
- var mode = $.effects.setMode(el, o.options.mode || 'show'); // Set Mode
- var direction = o.options.direction || 'left'; // Default Direction
-
- // Adjust
- $.effects.save(el, props); el.show(); // Save & Show
- $.effects.createWrapper(el).css({overflow:'hidden'}); // Create Wrapper
- var ref = (direction == 'up' || direction == 'down') ? 'top' : 'left';
- var motion = (direction == 'up' || direction == 'left') ? 'pos' : 'neg';
- var distance = o.options.distance || (ref == 'top' ? el.outerHeight({margin:true}) : el.outerWidth({margin:true}));
- if (mode == 'show') el.css(ref, motion == 'pos' ? (isNaN(distance) ? "-" + distance : -distance) : distance); // Shift
-
- // Animation
- var animation = {};
- animation[ref] = (mode == 'show' ? (motion == 'pos' ? '+=' : '-=') : (motion == 'pos' ? '-=' : '+=')) + distance;
-
- // Animate
- el.animate(animation, { queue: false, duration: o.duration, easing: o.options.easing, complete: function() {
- if(mode == 'hide') el.hide(); // Hide
- $.effects.restore(el, props); $.effects.removeWrapper(el); // Restore
- if(o.callback) o.callback.apply(this, arguments); // Callback
- el.dequeue();
- }});
-
- });
-
-};
-
-})(jQuery);
-/*
- * jQuery UI Effects Transfer 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Effects/Transfer
- *
- * Depends:
- * jquery.effects.core.js
- */
-(function( $, undefined ) {
-
-$.effects.transfer = function(o) {
- return this.queue(function() {
- var elem = $(this),
- target = $(o.options.to),
- endPosition = target.offset(),
- animation = {
- top: endPosition.top,
- left: endPosition.left,
- height: target.innerHeight(),
- width: target.innerWidth()
- },
- startPosition = elem.offset(),
- transfer = $('')
- .appendTo(document.body)
- .addClass(o.options.className)
- .css({
- top: startPosition.top,
- left: startPosition.left,
- height: elem.innerHeight(),
- width: elem.innerWidth(),
- position: 'absolute'
- })
- .animate(animation, o.duration, o.options.easing, function() {
- transfer.remove();
- (o.callback && o.callback.apply(elem[0], arguments));
- elem.dequeue();
- });
- });
-};
-
-})(jQuery);
-/*
- * jQuery UI Accordion 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Accordion
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.widget.js
- */
-(function( $, undefined ) {
-
-$.widget( "ui.accordion", {
- options: {
- active: 0,
- animated: "slide",
- autoHeight: true,
- clearStyle: false,
- collapsible: false,
- event: "click",
- fillSpace: false,
- header: "> li > :first-child,> :not(li):even",
- icons: {
- header: "ui-icon-triangle-1-e",
- headerSelected: "ui-icon-triangle-1-s"
- },
- navigation: false,
- navigationFilter: function() {
- return this.href.toLowerCase() === location.href.toLowerCase();
- }
- },
-
- _create: function() {
- var self = this,
- options = self.options;
-
- self.running = 0;
-
- self.element
- .addClass( "ui-accordion ui-widget ui-helper-reset" )
- // in lack of child-selectors in CSS
- // we need to mark top-LIs in a UL-accordion for some IE-fix
- .children( "li" )
- .addClass( "ui-accordion-li-fix" );
-
- self.headers = self.element.find( options.header )
- .addClass( "ui-accordion-header ui-helper-reset ui-state-default ui-corner-all" )
- .bind( "mouseenter.accordion", function() {
- if ( options.disabled ) {
- return;
- }
- $( this ).addClass( "ui-state-hover" );
- })
- .bind( "mouseleave.accordion", function() {
- if ( options.disabled ) {
- return;
- }
- $( this ).removeClass( "ui-state-hover" );
- })
- .bind( "focus.accordion", function() {
- if ( options.disabled ) {
- return;
- }
- $( this ).addClass( "ui-state-focus" );
- })
- .bind( "blur.accordion", function() {
- if ( options.disabled ) {
- return;
- }
- $( this ).removeClass( "ui-state-focus" );
- });
-
- self.headers.next()
- .addClass( "ui-accordion-content ui-helper-reset ui-widget-content ui-corner-bottom" );
-
- if ( options.navigation ) {
- var current = self.element.find( "a" ).filter( options.navigationFilter ).eq( 0 );
- if ( current.length ) {
- var header = current.closest( ".ui-accordion-header" );
- if ( header.length ) {
- // anchor within header
- self.active = header;
- } else {
- // anchor within content
- self.active = current.closest( ".ui-accordion-content" ).prev();
- }
- }
- }
-
- self.active = self._findActive( self.active || options.active )
- .addClass( "ui-state-default ui-state-active" )
- .toggleClass( "ui-corner-all" )
- .toggleClass( "ui-corner-top" );
- self.active.next().addClass( "ui-accordion-content-active" );
-
- self._createIcons();
- self.resize();
-
- // ARIA
- self.element.attr( "role", "tablist" );
-
- self.headers
- .attr( "role", "tab" )
- .bind( "keydown.accordion", function( event ) {
- return self._keydown( event );
- })
- .next()
- .attr( "role", "tabpanel" );
-
- self.headers
- .not( self.active || "" )
- .attr({
- "aria-expanded": "false",
- "aria-selected": "false",
- tabIndex: -1
- })
- .next()
- .hide();
-
- // make sure at least one header is in the tab order
- if ( !self.active.length ) {
- self.headers.eq( 0 ).attr( "tabIndex", 0 );
- } else {
- self.active
- .attr({
- "aria-expanded": "true",
- "aria-selected": "true",
- tabIndex: 0
- });
- }
-
- // only need links in tab order for Safari
- if ( !$.browser.safari ) {
- self.headers.find( "a" ).attr( "tabIndex", -1 );
- }
-
- if ( options.event ) {
- self.headers.bind( options.event.split(" ").join(".accordion ") + ".accordion", function(event) {
- self._clickHandler.call( self, event, this );
- event.preventDefault();
- });
- }
- },
-
- _createIcons: function() {
- var options = this.options;
- if ( options.icons ) {
- $( "" )
- .addClass( "ui-icon " + options.icons.header )
- .prependTo( this.headers );
- this.active.children( ".ui-icon" )
- .toggleClass(options.icons.header)
- .toggleClass(options.icons.headerSelected);
- this.element.addClass( "ui-accordion-icons" );
- }
- },
-
- _destroyIcons: function() {
- this.headers.children( ".ui-icon" ).remove();
- this.element.removeClass( "ui-accordion-icons" );
- },
-
- destroy: function() {
- var options = this.options;
-
- this.element
- .removeClass( "ui-accordion ui-widget ui-helper-reset" )
- .removeAttr( "role" );
-
- this.headers
- .unbind( ".accordion" )
- .removeClass( "ui-accordion-header ui-accordion-disabled ui-helper-reset ui-state-default ui-corner-all ui-state-active ui-state-disabled ui-corner-top" )
- .removeAttr( "role" )
- .removeAttr( "aria-expanded" )
- .removeAttr( "aria-selected" )
- .removeAttr( "tabIndex" );
-
- this.headers.find( "a" ).removeAttr( "tabIndex" );
- this._destroyIcons();
- var contents = this.headers.next()
- .css( "display", "" )
- .removeAttr( "role" )
- .removeClass( "ui-helper-reset ui-widget-content ui-corner-bottom ui-accordion-content ui-accordion-content-active ui-accordion-disabled ui-state-disabled" );
- if ( options.autoHeight || options.fillHeight ) {
- contents.css( "height", "" );
- }
-
- return $.Widget.prototype.destroy.call( this );
- },
-
- _setOption: function( key, value ) {
- $.Widget.prototype._setOption.apply( this, arguments );
-
- if ( key == "active" ) {
- this.activate( value );
- }
- if ( key == "icons" ) {
- this._destroyIcons();
- if ( value ) {
- this._createIcons();
- }
- }
- // #5332 - opacity doesn't cascade to positioned elements in IE
- // so we need to add the disabled class to the headers and panels
- if ( key == "disabled" ) {
- this.headers.add(this.headers.next())
- [ value ? "addClass" : "removeClass" ](
- "ui-accordion-disabled ui-state-disabled" );
- }
- },
-
- _keydown: function( event ) {
- if ( this.options.disabled || event.altKey || event.ctrlKey ) {
- return;
- }
-
- var keyCode = $.ui.keyCode,
- length = this.headers.length,
- currentIndex = this.headers.index( event.target ),
- toFocus = false;
-
- switch ( event.keyCode ) {
- case keyCode.RIGHT:
- case keyCode.DOWN:
- toFocus = this.headers[ ( currentIndex + 1 ) % length ];
- break;
- case keyCode.LEFT:
- case keyCode.UP:
- toFocus = this.headers[ ( currentIndex - 1 + length ) % length ];
- break;
- case keyCode.SPACE:
- case keyCode.ENTER:
- this._clickHandler( { target: event.target }, event.target );
- event.preventDefault();
- }
-
- if ( toFocus ) {
- $( event.target ).attr( "tabIndex", -1 );
- $( toFocus ).attr( "tabIndex", 0 );
- toFocus.focus();
- return false;
- }
-
- return true;
- },
-
- resize: function() {
- var options = this.options,
- maxHeight;
-
- if ( options.fillSpace ) {
- if ( $.browser.msie ) {
- var defOverflow = this.element.parent().css( "overflow" );
- this.element.parent().css( "overflow", "hidden");
- }
- maxHeight = this.element.parent().height();
- if ($.browser.msie) {
- this.element.parent().css( "overflow", defOverflow );
- }
-
- this.headers.each(function() {
- maxHeight -= $( this ).outerHeight( true );
- });
-
- this.headers.next()
- .each(function() {
- $( this ).height( Math.max( 0, maxHeight -
- $( this ).innerHeight() + $( this ).height() ) );
- })
- .css( "overflow", "auto" );
- } else if ( options.autoHeight ) {
- maxHeight = 0;
- this.headers.next()
- .each(function() {
- maxHeight = Math.max( maxHeight, $( this ).height( "" ).height() );
- })
- .height( maxHeight );
- }
-
- return this;
- },
-
- activate: function( index ) {
- // TODO this gets called on init, changing the option without an explicit call for that
- this.options.active = index;
- // call clickHandler with custom event
- var active = this._findActive( index )[ 0 ];
- this._clickHandler( { target: active }, active );
-
- return this;
- },
-
- _findActive: function( selector ) {
- return selector
- ? typeof selector === "number"
- ? this.headers.filter( ":eq(" + selector + ")" )
- : this.headers.not( this.headers.not( selector ) )
- : selector === false
- ? $( [] )
- : this.headers.filter( ":eq(0)" );
- },
-
- // TODO isn't event.target enough? why the separate target argument?
- _clickHandler: function( event, target ) {
- var options = this.options;
- if ( options.disabled ) {
- return;
- }
-
- // called only when using activate(false) to close all parts programmatically
- if ( !event.target ) {
- if ( !options.collapsible ) {
- return;
- }
- this.active
- .removeClass( "ui-state-active ui-corner-top" )
- .addClass( "ui-state-default ui-corner-all" )
- .children( ".ui-icon" )
- .removeClass( options.icons.headerSelected )
- .addClass( options.icons.header );
- this.active.next().addClass( "ui-accordion-content-active" );
- var toHide = this.active.next(),
- data = {
- options: options,
- newHeader: $( [] ),
- oldHeader: options.active,
- newContent: $( [] ),
- oldContent: toHide
- },
- toShow = ( this.active = $( [] ) );
- this._toggle( toShow, toHide, data );
- return;
- }
-
- // get the click target
- var clicked = $( event.currentTarget || target ),
- clickedIsActive = clicked[0] === this.active[0];
-
- // TODO the option is changed, is that correct?
- // TODO if it is correct, shouldn't that happen after determining that the click is valid?
- options.active = options.collapsible && clickedIsActive ?
- false :
- this.headers.index( clicked );
-
- // if animations are still active, or the active header is the target, ignore click
- if ( this.running || ( !options.collapsible && clickedIsActive ) ) {
- return;
- }
-
- // find elements to show and hide
- var active = this.active,
- toShow = clicked.next(),
- toHide = this.active.next(),
- data = {
- options: options,
- newHeader: clickedIsActive && options.collapsible ? $([]) : clicked,
- oldHeader: this.active,
- newContent: clickedIsActive && options.collapsible ? $([]) : toShow,
- oldContent: toHide
- },
- down = this.headers.index( this.active[0] ) > this.headers.index( clicked[0] );
-
- // when the call to ._toggle() comes after the class changes
- // it causes a very odd bug in IE 8 (see #6720)
- this.active = clickedIsActive ? $([]) : clicked;
- this._toggle( toShow, toHide, data, clickedIsActive, down );
-
- // switch classes
- active
- .removeClass( "ui-state-active ui-corner-top" )
- .addClass( "ui-state-default ui-corner-all" )
- .children( ".ui-icon" )
- .removeClass( options.icons.headerSelected )
- .addClass( options.icons.header );
- if ( !clickedIsActive ) {
- clicked
- .removeClass( "ui-state-default ui-corner-all" )
- .addClass( "ui-state-active ui-corner-top" )
- .children( ".ui-icon" )
- .removeClass( options.icons.header )
- .addClass( options.icons.headerSelected );
- clicked
- .next()
- .addClass( "ui-accordion-content-active" );
- }
-
- return;
- },
-
- _toggle: function( toShow, toHide, data, clickedIsActive, down ) {
- var self = this,
- options = self.options;
-
- self.toShow = toShow;
- self.toHide = toHide;
- self.data = data;
-
- var complete = function() {
- if ( !self ) {
- return;
- }
- return self._completed.apply( self, arguments );
- };
-
- // trigger changestart event
- self._trigger( "changestart", null, self.data );
-
- // count elements to animate
- self.running = toHide.size() === 0 ? toShow.size() : toHide.size();
-
- if ( options.animated ) {
- var animOptions = {};
-
- if ( options.collapsible && clickedIsActive ) {
- animOptions = {
- toShow: $( [] ),
- toHide: toHide,
- complete: complete,
- down: down,
- autoHeight: options.autoHeight || options.fillSpace
- };
- } else {
- animOptions = {
- toShow: toShow,
- toHide: toHide,
- complete: complete,
- down: down,
- autoHeight: options.autoHeight || options.fillSpace
- };
- }
-
- if ( !options.proxied ) {
- options.proxied = options.animated;
- }
-
- if ( !options.proxiedDuration ) {
- options.proxiedDuration = options.duration;
- }
-
- options.animated = $.isFunction( options.proxied ) ?
- options.proxied( animOptions ) :
- options.proxied;
-
- options.duration = $.isFunction( options.proxiedDuration ) ?
- options.proxiedDuration( animOptions ) :
- options.proxiedDuration;
-
- var animations = $.ui.accordion.animations,
- duration = options.duration,
- easing = options.animated;
-
- if ( easing && !animations[ easing ] && !$.easing[ easing ] ) {
- easing = "slide";
- }
- if ( !animations[ easing ] ) {
- animations[ easing ] = function( options ) {
- this.slide( options, {
- easing: easing,
- duration: duration || 700
- });
- };
- }
-
- animations[ easing ]( animOptions );
- } else {
- if ( options.collapsible && clickedIsActive ) {
- toShow.toggle();
- } else {
- toHide.hide();
- toShow.show();
- }
-
- complete( true );
- }
-
- // TODO assert that the blur and focus triggers are really necessary, remove otherwise
- toHide.prev()
- .attr({
- "aria-expanded": "false",
- "aria-selected": "false",
- tabIndex: -1
- })
- .blur();
- toShow.prev()
- .attr({
- "aria-expanded": "true",
- "aria-selected": "true",
- tabIndex: 0
- })
- .focus();
- },
-
- _completed: function( cancel ) {
- this.running = cancel ? 0 : --this.running;
- if ( this.running ) {
- return;
- }
-
- if ( this.options.clearStyle ) {
- this.toShow.add( this.toHide ).css({
- height: "",
- overflow: ""
- });
- }
-
- // other classes are removed before the animation; this one needs to stay until completed
- this.toHide.removeClass( "ui-accordion-content-active" );
- // Work around for rendering bug in IE (#5421)
- if ( this.toHide.length ) {
- this.toHide.parent()[0].className = this.toHide.parent()[0].className;
- }
-
- this._trigger( "change", null, this.data );
- }
-});
-
-$.extend( $.ui.accordion, {
- version: "1.8.14",
- animations: {
- slide: function( options, additions ) {
- options = $.extend({
- easing: "swing",
- duration: 300
- }, options, additions );
- if ( !options.toHide.size() ) {
- options.toShow.animate({
- height: "show",
- paddingTop: "show",
- paddingBottom: "show"
- }, options );
- return;
- }
- if ( !options.toShow.size() ) {
- options.toHide.animate({
- height: "hide",
- paddingTop: "hide",
- paddingBottom: "hide"
- }, options );
- return;
- }
- var overflow = options.toShow.css( "overflow" ),
- percentDone = 0,
- showProps = {},
- hideProps = {},
- fxAttrs = [ "height", "paddingTop", "paddingBottom" ],
- originalWidth;
- // fix width before calculating height of hidden element
- var s = options.toShow;
- originalWidth = s[0].style.width;
- s.width( parseInt( s.parent().width(), 10 )
- - parseInt( s.css( "paddingLeft" ), 10 )
- - parseInt( s.css( "paddingRight" ), 10 )
- - ( parseInt( s.css( "borderLeftWidth" ), 10 ) || 0 )
- - ( parseInt( s.css( "borderRightWidth" ), 10) || 0 ) );
-
- $.each( fxAttrs, function( i, prop ) {
- hideProps[ prop ] = "hide";
-
- var parts = ( "" + $.css( options.toShow[0], prop ) ).match( /^([\d+-.]+)(.*)$/ );
- showProps[ prop ] = {
- value: parts[ 1 ],
- unit: parts[ 2 ] || "px"
- };
- });
- options.toShow.css({ height: 0, overflow: "hidden" }).show();
- options.toHide
- .filter( ":hidden" )
- .each( options.complete )
- .end()
- .filter( ":visible" )
- .animate( hideProps, {
- step: function( now, settings ) {
- // only calculate the percent when animating height
- // IE gets very inconsistent results when animating elements
- // with small values, which is common for padding
- if ( settings.prop == "height" ) {
- percentDone = ( settings.end - settings.start === 0 ) ? 0 :
- ( settings.now - settings.start ) / ( settings.end - settings.start );
- }
-
- options.toShow[ 0 ].style[ settings.prop ] =
- ( percentDone * showProps[ settings.prop ].value )
- + showProps[ settings.prop ].unit;
- },
- duration: options.duration,
- easing: options.easing,
- complete: function() {
- if ( !options.autoHeight ) {
- options.toShow.css( "height", "" );
- }
- options.toShow.css({
- width: originalWidth,
- overflow: overflow
- });
- options.complete();
- }
- });
- },
- bounceslide: function( options ) {
- this.slide( options, {
- easing: options.down ? "easeOutBounce" : "swing",
- duration: options.down ? 1000 : 200
- });
- }
- }
-});
-
-})( jQuery );
-/*
- * jQuery UI Autocomplete 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Autocomplete
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.widget.js
- * jquery.ui.position.js
- */
-(function( $, undefined ) {
-
-// used to prevent race conditions with remote data sources
-var requestIndex = 0;
-
-$.widget( "ui.autocomplete", {
- options: {
- appendTo: "body",
- autoFocus: false,
- delay: 300,
- minLength: 1,
- position: {
- my: "left top",
- at: "left bottom",
- collision: "none"
- },
- source: null
- },
-
- pending: 0,
-
- _create: function() {
- var self = this,
- doc = this.element[ 0 ].ownerDocument,
- suppressKeyPress;
-
- this.element
- .addClass( "ui-autocomplete-input" )
- .attr( "autocomplete", "off" )
- // TODO verify these actually work as intended
- .attr({
- role: "textbox",
- "aria-autocomplete": "list",
- "aria-haspopup": "true"
- })
- .bind( "keydown.autocomplete", function( event ) {
- if ( self.options.disabled || self.element.attr( "readonly" ) ) {
- return;
- }
-
- suppressKeyPress = false;
- var keyCode = $.ui.keyCode;
- switch( event.keyCode ) {
- case keyCode.PAGE_UP:
- self._move( "previousPage", event );
- break;
- case keyCode.PAGE_DOWN:
- self._move( "nextPage", event );
- break;
- case keyCode.UP:
- self._move( "previous", event );
- // prevent moving cursor to beginning of text field in some browsers
- event.preventDefault();
- break;
- case keyCode.DOWN:
- self._move( "next", event );
- // prevent moving cursor to end of text field in some browsers
- event.preventDefault();
- break;
- case keyCode.ENTER:
- case keyCode.NUMPAD_ENTER:
- // when menu is open and has focus
- if ( self.menu.active ) {
- // #6055 - Opera still allows the keypress to occur
- // which causes forms to submit
- suppressKeyPress = true;
- event.preventDefault();
- }
- //passthrough - ENTER and TAB both select the current element
- case keyCode.TAB:
- if ( !self.menu.active ) {
- return;
- }
- self.menu.select( event );
- break;
- case keyCode.ESCAPE:
- self.element.val( self.term );
- self.close( event );
- break;
- default:
- // keypress is triggered before the input value is changed
- clearTimeout( self.searching );
- self.searching = setTimeout(function() {
- // only search if the value has changed
- if ( self.term != self.element.val() ) {
- self.selectedItem = null;
- self.search( null, event );
- }
- }, self.options.delay );
- break;
- }
- })
- .bind( "keypress.autocomplete", function( event ) {
- if ( suppressKeyPress ) {
- suppressKeyPress = false;
- event.preventDefault();
- }
- })
- .bind( "focus.autocomplete", function() {
- if ( self.options.disabled ) {
- return;
- }
-
- self.selectedItem = null;
- self.previous = self.element.val();
- })
- .bind( "blur.autocomplete", function( event ) {
- if ( self.options.disabled ) {
- return;
- }
-
- clearTimeout( self.searching );
- // clicks on the menu (or a button to trigger a search) will cause a blur event
- self.closing = setTimeout(function() {
- self.close( event );
- self._change( event );
- }, 150 );
- });
- this._initSource();
- this.response = function() {
- return self._response.apply( self, arguments );
- };
- this.menu = $( "
" )
- .addClass( "ui-autocomplete" )
- .appendTo( $( this.options.appendTo || "body", doc )[0] )
- // prevent the close-on-blur in case of a "slow" click on the menu (long mousedown)
- .mousedown(function( event ) {
- // clicking on the scrollbar causes focus to shift to the body
- // but we can't detect a mouseup or a click immediately afterward
- // so we have to track the next mousedown and close the menu if
- // the user clicks somewhere outside of the autocomplete
- var menuElement = self.menu.element[ 0 ];
- if ( !$( event.target ).closest( ".ui-menu-item" ).length ) {
- setTimeout(function() {
- $( document ).one( 'mousedown', function( event ) {
- if ( event.target !== self.element[ 0 ] &&
- event.target !== menuElement &&
- !$.ui.contains( menuElement, event.target ) ) {
- self.close();
- }
- });
- }, 1 );
- }
-
- // use another timeout to make sure the blur-event-handler on the input was already triggered
- setTimeout(function() {
- clearTimeout( self.closing );
- }, 13);
- })
- .menu({
- focus: function( event, ui ) {
- var item = ui.item.data( "item.autocomplete" );
- if ( false !== self._trigger( "focus", event, { item: item } ) ) {
- // use value to match what will end up in the input, if it was a key event
- if ( /^key/.test(event.originalEvent.type) ) {
- self.element.val( item.value );
- }
- }
- },
- selected: function( event, ui ) {
- var item = ui.item.data( "item.autocomplete" ),
- previous = self.previous;
-
- // only trigger when focus was lost (click on menu)
- if ( self.element[0] !== doc.activeElement ) {
- self.element.focus();
- self.previous = previous;
- // #6109 - IE triggers two focus events and the second
- // is asynchronous, so we need to reset the previous
- // term synchronously and asynchronously :-(
- setTimeout(function() {
- self.previous = previous;
- self.selectedItem = item;
- }, 1);
- }
-
- if ( false !== self._trigger( "select", event, { item: item } ) ) {
- self.element.val( item.value );
- }
- // reset the term after the select event
- // this allows custom select handling to work properly
- self.term = self.element.val();
-
- self.close( event );
- self.selectedItem = item;
- },
- blur: function( event, ui ) {
- // don't set the value of the text field if it's already correct
- // this prevents moving the cursor unnecessarily
- if ( self.menu.element.is(":visible") &&
- ( self.element.val() !== self.term ) ) {
- self.element.val( self.term );
- }
- }
- })
- .zIndex( this.element.zIndex() + 1 )
- // workaround for jQuery bug #5781 http://dev.jquery.com/ticket/5781
- .css({ top: 0, left: 0 })
- .hide()
- .data( "menu" );
- if ( $.fn.bgiframe ) {
- this.menu.element.bgiframe();
- }
- },
-
- destroy: function() {
- this.element
- .removeClass( "ui-autocomplete-input" )
- .removeAttr( "autocomplete" )
- .removeAttr( "role" )
- .removeAttr( "aria-autocomplete" )
- .removeAttr( "aria-haspopup" );
- this.menu.element.remove();
- $.Widget.prototype.destroy.call( this );
- },
-
- _setOption: function( key, value ) {
- $.Widget.prototype._setOption.apply( this, arguments );
- if ( key === "source" ) {
- this._initSource();
- }
- if ( key === "appendTo" ) {
- this.menu.element.appendTo( $( value || "body", this.element[0].ownerDocument )[0] )
- }
- if ( key === "disabled" && value && this.xhr ) {
- this.xhr.abort();
- }
- },
-
- _initSource: function() {
- var self = this,
- array,
- url;
- if ( $.isArray(this.options.source) ) {
- array = this.options.source;
- this.source = function( request, response ) {
- response( $.ui.autocomplete.filter(array, request.term) );
- };
- } else if ( typeof this.options.source === "string" ) {
- url = this.options.source;
- this.source = function( request, response ) {
- if ( self.xhr ) {
- self.xhr.abort();
- }
- self.xhr = $.ajax({
- url: url,
- data: request,
- dataType: "json",
- autocompleteRequest: ++requestIndex,
- success: function( data, status ) {
- if ( this.autocompleteRequest === requestIndex ) {
- response( data );
- }
- },
- error: function() {
- if ( this.autocompleteRequest === requestIndex ) {
- response( [] );
- }
- }
- });
- };
- } else {
- this.source = this.options.source;
- }
- },
-
- search: function( value, event ) {
- value = value != null ? value : this.element.val();
-
- // always save the actual value, not the one passed as an argument
- this.term = this.element.val();
-
- if ( value.length < this.options.minLength ) {
- return this.close( event );
- }
-
- clearTimeout( this.closing );
- if ( this._trigger( "search", event ) === false ) {
- return;
- }
-
- return this._search( value );
- },
-
- _search: function( value ) {
- this.pending++;
- this.element.addClass( "ui-autocomplete-loading" );
-
- this.source( { term: value }, this.response );
- },
-
- _response: function( content ) {
- if ( !this.options.disabled && content && content.length ) {
- content = this._normalize( content );
- this._suggest( content );
- this._trigger( "open" );
- } else {
- this.close();
- }
- this.pending--;
- if ( !this.pending ) {
- this.element.removeClass( "ui-autocomplete-loading" );
- }
- },
-
- close: function( event ) {
- clearTimeout( this.closing );
- if ( this.menu.element.is(":visible") ) {
- this.menu.element.hide();
- this.menu.deactivate();
- this._trigger( "close", event );
- }
- },
-
- _change: function( event ) {
- if ( this.previous !== this.element.val() ) {
- this._trigger( "change", event, { item: this.selectedItem } );
- }
- },
-
- _normalize: function( items ) {
- // assume all items have the right format when the first item is complete
- if ( items.length && items[0].label && items[0].value ) {
- return items;
- }
- return $.map( items, function(item) {
- if ( typeof item === "string" ) {
- return {
- label: item,
- value: item
- };
- }
- return $.extend({
- label: item.label || item.value,
- value: item.value || item.label
- }, item );
- });
- },
-
- _suggest: function( items ) {
- var ul = this.menu.element
- .empty()
- .zIndex( this.element.zIndex() + 1 );
- this._renderMenu( ul, items );
- // TODO refresh should check if the active item is still in the dom, removing the need for a manual deactivate
- this.menu.deactivate();
- this.menu.refresh();
-
- // size and position menu
- ul.show();
- this._resizeMenu();
- ul.position( $.extend({
- of: this.element
- }, this.options.position ));
-
- if ( this.options.autoFocus ) {
- this.menu.next( new $.Event("mouseover") );
- }
- },
-
- _resizeMenu: function() {
- var ul = this.menu.element;
- ul.outerWidth( Math.max(
- ul.width( "" ).outerWidth(),
- this.element.outerWidth()
- ) );
- },
-
- _renderMenu: function( ul, items ) {
- var self = this;
- $.each( items, function( index, item ) {
- self._renderItem( ul, item );
- });
- },
-
- _renderItem: function( ul, item) {
- return $( "" )
- .data( "item.autocomplete", item )
- .append( $( "" ).text( item.label ) )
- .appendTo( ul );
- },
-
- _move: function( direction, event ) {
- if ( !this.menu.element.is(":visible") ) {
- this.search( null, event );
- return;
- }
- if ( this.menu.first() && /^previous/.test(direction) ||
- this.menu.last() && /^next/.test(direction) ) {
- this.element.val( this.term );
- this.menu.deactivate();
- return;
- }
- this.menu[ direction ]( event );
- },
-
- widget: function() {
- return this.menu.element;
- }
-});
-
-$.extend( $.ui.autocomplete, {
- escapeRegex: function( value ) {
- return value.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
- },
- filter: function(array, term) {
- var matcher = new RegExp( $.ui.autocomplete.escapeRegex(term), "i" );
- return $.grep( array, function(value) {
- return matcher.test( value.label || value.value || value );
- });
- }
-});
-
-}( jQuery ));
-
-/*
- * jQuery UI Menu (not officially released)
- *
- * This widget isn't yet finished and the API is subject to change. We plan to finish
- * it for the next release. You're welcome to give it a try anyway and give us feedback,
- * as long as you're okay with migrating your code later on. We can help with that, too.
- *
- * Copyright 2010, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Menu
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.widget.js
- */
-(function($) {
-
-$.widget("ui.menu", {
- _create: function() {
- var self = this;
- this.element
- .addClass("ui-menu ui-widget ui-widget-content ui-corner-all")
- .attr({
- role: "listbox",
- "aria-activedescendant": "ui-active-menuitem"
- })
- .click(function( event ) {
- if ( !$( event.target ).closest( ".ui-menu-item a" ).length ) {
- return;
- }
- // temporary
- event.preventDefault();
- self.select( event );
- });
- this.refresh();
- },
-
- refresh: function() {
- var self = this;
-
- // don't refresh list items that are already adapted
- var items = this.element.children("li:not(.ui-menu-item):has(a)")
- .addClass("ui-menu-item")
- .attr("role", "menuitem");
-
- items.children("a")
- .addClass("ui-corner-all")
- .attr("tabindex", -1)
- // mouseenter doesn't work with event delegation
- .mouseenter(function( event ) {
- self.activate( event, $(this).parent() );
- })
- .mouseleave(function() {
- self.deactivate();
- });
- },
-
- activate: function( event, item ) {
- this.deactivate();
- if (this.hasScroll()) {
- var offset = item.offset().top - this.element.offset().top,
- scroll = this.element.scrollTop(),
- elementHeight = this.element.height();
- if (offset < 0) {
- this.element.scrollTop( scroll + offset);
- } else if (offset >= elementHeight) {
- this.element.scrollTop( scroll + offset - elementHeight + item.height());
- }
- }
- this.active = item.eq(0)
- .children("a")
- .addClass("ui-state-hover")
- .attr("id", "ui-active-menuitem")
- .end();
- this._trigger("focus", event, { item: item });
- },
-
- deactivate: function() {
- if (!this.active) { return; }
-
- this.active.children("a")
- .removeClass("ui-state-hover")
- .removeAttr("id");
- this._trigger("blur");
- this.active = null;
- },
-
- next: function(event) {
- this.move("next", ".ui-menu-item:first", event);
- },
-
- previous: function(event) {
- this.move("prev", ".ui-menu-item:last", event);
- },
-
- first: function() {
- return this.active && !this.active.prevAll(".ui-menu-item").length;
- },
-
- last: function() {
- return this.active && !this.active.nextAll(".ui-menu-item").length;
- },
-
- move: function(direction, edge, event) {
- if (!this.active) {
- this.activate(event, this.element.children(edge));
- return;
- }
- var next = this.active[direction + "All"](".ui-menu-item").eq(0);
- if (next.length) {
- this.activate(event, next);
- } else {
- this.activate(event, this.element.children(edge));
- }
- },
-
- // TODO merge with previousPage
- nextPage: function(event) {
- if (this.hasScroll()) {
- // TODO merge with no-scroll-else
- if (!this.active || this.last()) {
- this.activate(event, this.element.children(".ui-menu-item:first"));
- return;
- }
- var base = this.active.offset().top,
- height = this.element.height(),
- result = this.element.children(".ui-menu-item").filter(function() {
- var close = $(this).offset().top - base - height + $(this).height();
- // TODO improve approximation
- return close < 10 && close > -10;
- });
-
- // TODO try to catch this earlier when scrollTop indicates the last page anyway
- if (!result.length) {
- result = this.element.children(".ui-menu-item:last");
- }
- this.activate(event, result);
- } else {
- this.activate(event, this.element.children(".ui-menu-item")
- .filter(!this.active || this.last() ? ":first" : ":last"));
- }
- },
-
- // TODO merge with nextPage
- previousPage: function(event) {
- if (this.hasScroll()) {
- // TODO merge with no-scroll-else
- if (!this.active || this.first()) {
- this.activate(event, this.element.children(".ui-menu-item:last"));
- return;
- }
-
- var base = this.active.offset().top,
- height = this.element.height();
- result = this.element.children(".ui-menu-item").filter(function() {
- var close = $(this).offset().top - base + height - $(this).height();
- // TODO improve approximation
- return close < 10 && close > -10;
- });
-
- // TODO try to catch this earlier when scrollTop indicates the last page anyway
- if (!result.length) {
- result = this.element.children(".ui-menu-item:first");
- }
- this.activate(event, result);
- } else {
- this.activate(event, this.element.children(".ui-menu-item")
- .filter(!this.active || this.first() ? ":last" : ":first"));
- }
- },
-
- hasScroll: function() {
- return this.element.height() < this.element[ $.fn.prop ? "prop" : "attr" ]("scrollHeight");
- },
-
- select: function( event ) {
- this._trigger("selected", event, { item: this.active });
- }
-});
-
-}(jQuery));
-/*
- * jQuery UI Button 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Button
- *
- * Depends:
- * jquery.ui.core.js
- * jquery.ui.widget.js
- */
-(function( $, undefined ) {
-
-var lastActive, startXPos, startYPos, clickDragged,
- baseClasses = "ui-button ui-widget ui-state-default ui-corner-all",
- stateClasses = "ui-state-hover ui-state-active ",
- typeClasses = "ui-button-icons-only ui-button-icon-only ui-button-text-icons ui-button-text-icon-primary ui-button-text-icon-secondary ui-button-text-only",
- formResetHandler = function() {
- var buttons = $( this ).find( ":ui-button" );
- setTimeout(function() {
- buttons.button( "refresh" );
- }, 1 );
- },
- radioGroup = function( radio ) {
- var name = radio.name,
- form = radio.form,
- radios = $( [] );
- if ( name ) {
- if ( form ) {
- radios = $( form ).find( "[name='" + name + "']" );
- } else {
- radios = $( "[name='" + name + "']", radio.ownerDocument )
- .filter(function() {
- return !this.form;
- });
- }
- }
- return radios;
- };
-
-$.widget( "ui.button", {
- options: {
- disabled: null,
- text: true,
- label: null,
- icons: {
- primary: null,
- secondary: null
- }
- },
- _create: function() {
- this.element.closest( "form" )
- .unbind( "reset.button" )
- .bind( "reset.button", formResetHandler );
-
- if ( typeof this.options.disabled !== "boolean" ) {
- this.options.disabled = this.element.attr( "disabled" );
- }
-
- this._determineButtonType();
- this.hasTitle = !!this.buttonElement.attr( "title" );
-
- var self = this,
- options = this.options,
- toggleButton = this.type === "checkbox" || this.type === "radio",
- hoverClass = "ui-state-hover" + ( !toggleButton ? " ui-state-active" : "" ),
- focusClass = "ui-state-focus";
-
- if ( options.label === null ) {
- options.label = this.buttonElement.html();
- }
-
- if ( this.element.is( ":disabled" ) ) {
- options.disabled = true;
- }
-
- this.buttonElement
- .addClass( baseClasses )
- .attr( "role", "button" )
- .bind( "mouseenter.button", function() {
- if ( options.disabled ) {
- return;
- }
- $( this ).addClass( "ui-state-hover" );
- if ( this === lastActive ) {
- $( this ).addClass( "ui-state-active" );
- }
- })
- .bind( "mouseleave.button", function() {
- if ( options.disabled ) {
- return;
- }
- $( this ).removeClass( hoverClass );
- })
- .bind( "click.button", function( event ) {
- if ( options.disabled ) {
- event.preventDefault();
- event.stopImmediatePropagation();
- }
- });
-
- this.element
- .bind( "focus.button", function() {
- // no need to check disabled, focus won't be triggered anyway
- self.buttonElement.addClass( focusClass );
- })
- .bind( "blur.button", function() {
- self.buttonElement.removeClass( focusClass );
- });
-
- if ( toggleButton ) {
- this.element.bind( "change.button", function() {
- if ( clickDragged ) {
- return;
- }
- self.refresh();
- });
- // if mouse moves between mousedown and mouseup (drag) set clickDragged flag
- // prevents issue where button state changes but checkbox/radio checked state
- // does not in Firefox (see ticket #6970)
- this.buttonElement
- .bind( "mousedown.button", function( event ) {
- if ( options.disabled ) {
- return;
- }
- clickDragged = false;
- startXPos = event.pageX;
- startYPos = event.pageY;
- })
- .bind( "mouseup.button", function( event ) {
- if ( options.disabled ) {
- return;
- }
- if ( startXPos !== event.pageX || startYPos !== event.pageY ) {
- clickDragged = true;
- }
- });
- }
-
- if ( this.type === "checkbox" ) {
- this.buttonElement.bind( "click.button", function() {
- if ( options.disabled || clickDragged ) {
- return false;
- }
- $( this ).toggleClass( "ui-state-active" );
- self.buttonElement.attr( "aria-pressed", self.element[0].checked );
- });
- } else if ( this.type === "radio" ) {
- this.buttonElement.bind( "click.button", function() {
- if ( options.disabled || clickDragged ) {
- return false;
- }
- $( this ).addClass( "ui-state-active" );
- self.buttonElement.attr( "aria-pressed", true );
-
- var radio = self.element[ 0 ];
- radioGroup( radio )
- .not( radio )
- .map(function() {
- return $( this ).button( "widget" )[ 0 ];
- })
- .removeClass( "ui-state-active" )
- .attr( "aria-pressed", false );
- });
- } else {
- this.buttonElement
- .bind( "mousedown.button", function() {
- if ( options.disabled ) {
- return false;
- }
- $( this ).addClass( "ui-state-active" );
- lastActive = this;
- $( document ).one( "mouseup", function() {
- lastActive = null;
- });
- })
- .bind( "mouseup.button", function() {
- if ( options.disabled ) {
- return false;
- }
- $( this ).removeClass( "ui-state-active" );
- })
- .bind( "keydown.button", function(event) {
- if ( options.disabled ) {
- return false;
- }
- if ( event.keyCode == $.ui.keyCode.SPACE || event.keyCode == $.ui.keyCode.ENTER ) {
- $( this ).addClass( "ui-state-active" );
- }
- })
- .bind( "keyup.button", function() {
- $( this ).removeClass( "ui-state-active" );
- });
-
- if ( this.buttonElement.is("a") ) {
- this.buttonElement.keyup(function(event) {
- if ( event.keyCode === $.ui.keyCode.SPACE ) {
- // TODO pass through original event correctly (just as 2nd argument doesn't work)
- $( this ).click();
- }
- });
- }
- }
-
- // TODO: pull out $.Widget's handling for the disabled option into
- // $.Widget.prototype._setOptionDisabled so it's easy to proxy and can
- // be overridden by individual plugins
- this._setOption( "disabled", options.disabled );
- this._resetButton();
- },
-
- _determineButtonType: function() {
-
- if ( this.element.is(":checkbox") ) {
- this.type = "checkbox";
- } else if ( this.element.is(":radio") ) {
- this.type = "radio";
- } else if ( this.element.is("input") ) {
- this.type = "input";
- } else {
- this.type = "button";
- }
-
- if ( this.type === "checkbox" || this.type === "radio" ) {
- // we don't search against the document in case the element
- // is disconnected from the DOM
- var ancestor = this.element.parents().filter(":last"),
- labelSelector = "label[for=" + this.element.attr("id") + "]";
- this.buttonElement = ancestor.find( labelSelector );
- if ( !this.buttonElement.length ) {
- ancestor = ancestor.length ? ancestor.siblings() : this.element.siblings();
- this.buttonElement = ancestor.filter( labelSelector );
- if ( !this.buttonElement.length ) {
- this.buttonElement = ancestor.find( labelSelector );
- }
- }
- this.element.addClass( "ui-helper-hidden-accessible" );
-
- var checked = this.element.is( ":checked" );
- if ( checked ) {
- this.buttonElement.addClass( "ui-state-active" );
- }
- this.buttonElement.attr( "aria-pressed", checked );
- } else {
- this.buttonElement = this.element;
- }
- },
-
- widget: function() {
- return this.buttonElement;
- },
-
- destroy: function() {
- this.element
- .removeClass( "ui-helper-hidden-accessible" );
- this.buttonElement
- .removeClass( baseClasses + " " + stateClasses + " " + typeClasses )
- .removeAttr( "role" )
- .removeAttr( "aria-pressed" )
- .html( this.buttonElement.find(".ui-button-text").html() );
-
- if ( !this.hasTitle ) {
- this.buttonElement.removeAttr( "title" );
- }
-
- $.Widget.prototype.destroy.call( this );
- },
-
- _setOption: function( key, value ) {
- $.Widget.prototype._setOption.apply( this, arguments );
- if ( key === "disabled" ) {
- if ( value ) {
- this.element.attr( "disabled", true );
- } else {
- this.element.removeAttr( "disabled" );
- }
- return;
- }
- this._resetButton();
- },
-
- refresh: function() {
- var isDisabled = this.element.is( ":disabled" );
- if ( isDisabled !== this.options.disabled ) {
- this._setOption( "disabled", isDisabled );
- }
- if ( this.type === "radio" ) {
- radioGroup( this.element[0] ).each(function() {
- if ( $( this ).is( ":checked" ) ) {
- $( this ).button( "widget" )
- .addClass( "ui-state-active" )
- .attr( "aria-pressed", true );
- } else {
- $( this ).button( "widget" )
- .removeClass( "ui-state-active" )
- .attr( "aria-pressed", false );
- }
- });
- } else if ( this.type === "checkbox" ) {
- if ( this.element.is( ":checked" ) ) {
- this.buttonElement
- .addClass( "ui-state-active" )
- .attr( "aria-pressed", true );
- } else {
- this.buttonElement
- .removeClass( "ui-state-active" )
- .attr( "aria-pressed", false );
- }
- }
- },
-
- _resetButton: function() {
- if ( this.type === "input" ) {
- if ( this.options.label ) {
- this.element.val( this.options.label );
- }
- return;
- }
- var buttonElement = this.buttonElement.removeClass( typeClasses ),
- buttonText = $( "" )
- .addClass( "ui-button-text" )
- .html( this.options.label )
- .appendTo( buttonElement.empty() )
- .text(),
- icons = this.options.icons,
- multipleIcons = icons.primary && icons.secondary,
- buttonClasses = [];
-
- if ( icons.primary || icons.secondary ) {
- if ( this.options.text ) {
- buttonClasses.push( "ui-button-text-icon" + ( multipleIcons ? "s" : ( icons.primary ? "-primary" : "-secondary" ) ) );
- }
-
- if ( icons.primary ) {
- buttonElement.prepend( "" );
- }
-
- if ( icons.secondary ) {
- buttonElement.append( "" );
- }
-
- if ( !this.options.text ) {
- buttonClasses.push( multipleIcons ? "ui-button-icons-only" : "ui-button-icon-only" );
-
- if ( !this.hasTitle ) {
- buttonElement.attr( "title", buttonText );
- }
- }
- } else {
- buttonClasses.push( "ui-button-text-only" );
- }
- buttonElement.addClass( buttonClasses.join( " " ) );
- }
-});
-
-$.widget( "ui.buttonset", {
- options: {
- items: ":button, :submit, :reset, :checkbox, :radio, a, :data(button)"
- },
-
- _create: function() {
- this.element.addClass( "ui-buttonset" );
- },
-
- _init: function() {
- this.refresh();
- },
-
- _setOption: function( key, value ) {
- if ( key === "disabled" ) {
- this.buttons.button( "option", key, value );
- }
-
- $.Widget.prototype._setOption.apply( this, arguments );
- },
-
- refresh: function() {
- var ltr = this.element.css( "direction" ) === "ltr";
-
- this.buttons = this.element.find( this.options.items )
- .filter( ":ui-button" )
- .button( "refresh" )
- .end()
- .not( ":ui-button" )
- .button()
- .end()
- .map(function() {
- return $( this ).button( "widget" )[ 0 ];
- })
- .removeClass( "ui-corner-all ui-corner-left ui-corner-right" )
- .filter( ":first" )
- .addClass( ltr ? "ui-corner-left" : "ui-corner-right" )
- .end()
- .filter( ":last" )
- .addClass( ltr ? "ui-corner-right" : "ui-corner-left" )
- .end()
- .end();
- },
-
- destroy: function() {
- this.element.removeClass( "ui-buttonset" );
- this.buttons
- .map(function() {
- return $( this ).button( "widget" )[ 0 ];
- })
- .removeClass( "ui-corner-left ui-corner-right" )
- .end()
- .button( "destroy" );
-
- $.Widget.prototype.destroy.call( this );
- }
-});
-
-}( jQuery ) );
-/*
- * jQuery UI Datepicker 1.8.14
- *
- * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
- * Dual licensed under the MIT or GPL Version 2 licenses.
- * http://jquery.org/license
- *
- * http://docs.jquery.com/UI/Datepicker
- *
- * Depends:
- * jquery.ui.core.js
- */
-(function( $, undefined ) {
-
-$.extend($.ui, { datepicker: { version: "1.8.14" } });
-
-var PROP_NAME = 'datepicker';
-var dpuuid = new Date().getTime();
-var instActive;
-
-/* Date picker manager.
- Use the singleton instance of this class, $.datepicker, to interact with the date picker.
- Settings for (groups of) date pickers are maintained in an instance object,
- allowing multiple different settings on the same page. */
-
-function Datepicker() {
- this.debug = false; // Change this to true to start debugging
- this._curInst = null; // The current instance in use
- this._keyEvent = false; // If the last event was a key event
- this._disabledInputs = []; // List of date picker inputs that have been disabled
- this._datepickerShowing = false; // True if the popup picker is showing , false if not
- this._inDialog = false; // True if showing within a "dialog", false if not
- this._mainDivId = 'ui-datepicker-div'; // The ID of the main datepicker division
- this._inlineClass = 'ui-datepicker-inline'; // The name of the inline marker class
- this._appendClass = 'ui-datepicker-append'; // The name of the append marker class
- this._triggerClass = 'ui-datepicker-trigger'; // The name of the trigger marker class
- this._dialogClass = 'ui-datepicker-dialog'; // The name of the dialog marker class
- this._disableClass = 'ui-datepicker-disabled'; // The name of the disabled covering marker class
- this._unselectableClass = 'ui-datepicker-unselectable'; // The name of the unselectable cell marker class
- this._currentClass = 'ui-datepicker-current-day'; // The name of the current day marker class
- this._dayOverClass = 'ui-datepicker-days-cell-over'; // The name of the day hover marker class
- this.regional = []; // Available regional settings, indexed by language code
- this.regional[''] = { // Default regional settings
- closeText: 'Done', // Display text for close link
- prevText: 'Prev', // Display text for previous month link
- nextText: 'Next', // Display text for next month link
- currentText: 'Today', // Display text for current month link
- monthNames: ['January','February','March','April','May','June',
- 'July','August','September','October','November','December'], // Names of months for drop-down and formatting
- monthNamesShort: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'], // For formatting
- dayNames: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'], // For formatting
- dayNamesShort: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'], // For formatting
- dayNamesMin: ['Su','Mo','Tu','We','Th','Fr','Sa'], // Column headings for days starting at Sunday
- weekHeader: 'Wk', // Column header for week of the year
- dateFormat: 'mm/dd/yy', // See format options on parseDate
- firstDay: 0, // The first day of the week, Sun = 0, Mon = 1, ...
- isRTL: false, // True if right-to-left language, false if left-to-right
- showMonthAfterYear: false, // True if the year select precedes month, false for month then year
- yearSuffix: '' // Additional text to append to the year in the month headers
- };
- this._defaults = { // Global defaults for all the date picker instances
- showOn: 'focus', // 'focus' for popup on focus,
- // 'button' for trigger button, or 'both' for either
- showAnim: 'fadeIn', // Name of jQuery animation for popup
- showOptions: {}, // Options for enhanced animations
- defaultDate: null, // Used when field is blank: actual date,
- // +/-number for offset from today, null for today
- appendText: '', // Display text following the input box, e.g. showing the format
- buttonText: '...', // Text for trigger button
- buttonImage: '', // URL for trigger button image
- buttonImageOnly: false, // True if the image appears alone, false if it appears on a button
- hideIfNoPrevNext: false, // True to hide next/previous month links
- // if not applicable, false to just disable them
- navigationAsDateFormat: false, // True if date formatting applied to prev/today/next links
- gotoCurrent: false, // True if today link goes back to current selection instead
- changeMonth: false, // True if month can be selected directly, false if only prev/next
- changeYear: false, // True if year can be selected directly, false if only prev/next
- yearRange: 'c-10:c+10', // Range of years to display in drop-down,
- // either relative to today's year (-nn:+nn), relative to currently displayed year
- // (c-nn:c+nn), absolute (nnnn:nnnn), or a combination of the above (nnnn:-n)
- showOtherMonths: false, // True to show dates in other months, false to leave blank
- selectOtherMonths: false, // True to allow selection of dates in other months, false for unselectable
- showWeek: false, // True to show week of the year, false to not show it
- calculateWeek: this.iso8601Week, // How to calculate the week of the year,
- // takes a Date and returns the number of the week for it
- shortYearCutoff: '+10', // Short year values < this are in the current century,
- // > this are in the previous century,
- // string value starting with '+' for current year + value
- minDate: null, // The earliest selectable date, or null for no limit
- maxDate: null, // The latest selectable date, or null for no limit
- duration: 'fast', // Duration of display/closure
- beforeShowDay: null, // Function that takes a date and returns an array with
- // [0] = true if selectable, false if not, [1] = custom CSS class name(s) or '',
- // [2] = cell title (optional), e.g. $.datepicker.noWeekends
- beforeShow: null, // Function that takes an input field and
- // returns a set of custom settings for the date picker
- onSelect: null, // Define a callback function when a date is selected
- onChangeMonthYear: null, // Define a callback function when the month or year is changed
- onClose: null, // Define a callback function when the datepicker is closed
- numberOfMonths: 1, // Number of months to show at a time
- showCurrentAtPos: 0, // The position in multipe months at which to show the current month (starting at 0)
- stepMonths: 1, // Number of months to step back/forward
- stepBigMonths: 12, // Number of months to step back/forward for the big links
- altField: '', // Selector for an alternate field to store selected dates into
- altFormat: '', // The date format to use for the alternate field
- constrainInput: true, // The input is constrained by the current date format
- showButtonPanel: false, // True to show button panel, false to not show it
- autoSize: false // True to size the input for the date format, false to leave as is
- };
- $.extend(this._defaults, this.regional['']);
- this.dpDiv = bindHover($(''));
-}
-
-$.extend(Datepicker.prototype, {
- /* Class name added to elements to indicate already configured with a date picker. */
- markerClassName: 'hasDatepicker',
-
- //Keep track of the maximum number of rows displayed (see #7043)
- maxRows: 4,
-
- /* Debug logging (if enabled). */
- log: function () {
- if (this.debug)
- console.log.apply('', arguments);
- },
-
- // TODO rename to "widget" when switching to widget factory
- _widgetDatepicker: function() {
- return this.dpDiv;
- },
-
- /* Override the default settings for all instances of the date picker.
- @param settings object - the new settings to use as defaults (anonymous object)
- @return the manager object */
- setDefaults: function(settings) {
- extendRemove(this._defaults, settings || {});
- return this;
- },
-
- /* Attach the date picker to a jQuery selection.
- @param target element - the target input field or division or span
- @param settings object - the new settings to use for this date picker instance (anonymous) */
- _attachDatepicker: function(target, settings) {
- // check for settings on the control itself - in namespace 'date:'
- var inlineSettings = null;
- for (var attrName in this._defaults) {
- var attrValue = target.getAttribute('date:' + attrName);
- if (attrValue) {
- inlineSettings = inlineSettings || {};
- try {
- inlineSettings[attrName] = eval(attrValue);
- } catch (err) {
- inlineSettings[attrName] = attrValue;
- }
- }
- }
- var nodeName = target.nodeName.toLowerCase();
- var inline = (nodeName == 'div' || nodeName == 'span');
- if (!target.id) {
- this.uuid += 1;
- target.id = 'dp' + this.uuid;
- }
- var inst = this._newInst($(target), inline);
- inst.settings = $.extend({}, settings || {}, inlineSettings || {});
- if (nodeName == 'input') {
- this._connectDatepicker(target, inst);
- } else if (inline) {
- this._inlineDatepicker(target, inst);
- }
- },
-
- /* Create a new instance object. */
- _newInst: function(target, inline) {
- var id = target[0].id.replace(/([^A-Za-z0-9_-])/g, '\\\\$1'); // escape jQuery meta chars
- return {id: id, input: target, // associated target
- selectedDay: 0, selectedMonth: 0, selectedYear: 0, // current selection
- drawMonth: 0, drawYear: 0, // month being drawn
- inline: inline, // is datepicker inline or not
- dpDiv: (!inline ? this.dpDiv : // presentation div
- bindHover($('')))};
- },
-
- /* Attach the date picker to an input field. */
- _connectDatepicker: function(target, inst) {
- var input = $(target);
- inst.append = $([]);
- inst.trigger = $([]);
- if (input.hasClass(this.markerClassName))
- return;
- this._attachments(input, inst);
- input.addClass(this.markerClassName).keydown(this._doKeyDown).
- keypress(this._doKeyPress).keyup(this._doKeyUp).
- bind("setData.datepicker", function(event, key, value) {
- inst.settings[key] = value;
- }).bind("getData.datepicker", function(event, key) {
- return this._get(inst, key);
- });
- this._autoSize(inst);
- $.data(target, PROP_NAME, inst);
- },
-
- /* Make attachments based on settings. */
- _attachments: function(input, inst) {
- var appendText = this._get(inst, 'appendText');
- var isRTL = this._get(inst, 'isRTL');
- if (inst.append)
- inst.append.remove();
- if (appendText) {
- inst.append = $('' + appendText + '');
- input[isRTL ? 'before' : 'after'](inst.append);
- }
- input.unbind('focus', this._showDatepicker);
- if (inst.trigger)
- inst.trigger.remove();
- var showOn = this._get(inst, 'showOn');
- if (showOn == 'focus' || showOn == 'both') // pop-up date picker when in the marked field
- input.focus(this._showDatepicker);
- if (showOn == 'button' || showOn == 'both') { // pop-up date picker when button clicked
- var buttonText = this._get(inst, 'buttonText');
- var buttonImage = this._get(inst, 'buttonImage');
- inst.trigger = $(this._get(inst, 'buttonImageOnly') ?
- $('').addClass(this._triggerClass).
- attr({ src: buttonImage, alt: buttonText, title: buttonText }) :
- $('').addClass(this._triggerClass).
- html(buttonImage == '' ? buttonText : $('').attr(
- { src:buttonImage, alt:buttonText, title:buttonText })));
- input[isRTL ? 'before' : 'after'](inst.trigger);
- inst.trigger.click(function() {
- if ($.datepicker._datepickerShowing && $.datepicker._lastInput == input[0])
- $.datepicker._hideDatepicker();
- else
- $.datepicker._showDatepicker(input[0]);
- return false;
- });
- }
- },
-
- /* Apply the maximum length for the date format. */
- _autoSize: function(inst) {
- if (this._get(inst, 'autoSize') && !inst.inline) {
- var date = new Date(2009, 12 - 1, 20); // Ensure double digits
- var dateFormat = this._get(inst, 'dateFormat');
- if (dateFormat.match(/[DM]/)) {
- var findMax = function(names) {
- var max = 0;
- var maxI = 0;
- for (var i = 0; i < names.length; i++) {
- if (names[i].length > max) {
- max = names[i].length;
- maxI = i;
- }
- }
- return maxI;
- };
- date.setMonth(findMax(this._get(inst, (dateFormat.match(/MM/) ?
- 'monthNames' : 'monthNamesShort'))));
- date.setDate(findMax(this._get(inst, (dateFormat.match(/DD/) ?
- 'dayNames' : 'dayNamesShort'))) + 20 - date.getDay());
- }
- inst.input.attr('size', this._formatDate(inst, date).length);
- }
- },
-
- /* Attach an inline date picker to a div. */
- _inlineDatepicker: function(target, inst) {
- var divSpan = $(target);
- if (divSpan.hasClass(this.markerClassName))
- return;
- divSpan.addClass(this.markerClassName).append(inst.dpDiv).
- bind("setData.datepicker", function(event, key, value){
- inst.settings[key] = value;
- }).bind("getData.datepicker", function(event, key){
- return this._get(inst, key);
- });
- $.data(target, PROP_NAME, inst);
- this._setDate(inst, this._getDefaultDate(inst), true);
- this._updateDatepicker(inst);
- this._updateAlternate(inst);
- inst.dpDiv.show();
- },
-
- /* Pop-up the date picker in a "dialog" box.
- @param input element - ignored
- @param date string or Date - the initial date to display
- @param onSelect function - the function to call when a date is selected
- @param settings object - update the dialog date picker instance's settings (anonymous object)
- @param pos int[2] - coordinates for the dialog's position within the screen or
- event - with x/y coordinates or
- leave empty for default (screen centre)
- @return the manager object */
- _dialogDatepicker: function(input, date, onSelect, settings, pos) {
- var inst = this._dialogInst; // internal instance
- if (!inst) {
- this.uuid += 1;
- var id = 'dp' + this.uuid;
- this._dialogInput = $('');
- this._dialogInput.keydown(this._doKeyDown);
- $('body').append(this._dialogInput);
- inst = this._dialogInst = this._newInst(this._dialogInput, false);
- inst.settings = {};
- $.data(this._dialogInput[0], PROP_NAME, inst);
- }
- extendRemove(inst.settings, settings || {});
- date = (date && date.constructor == Date ? this._formatDate(inst, date) : date);
- this._dialogInput.val(date);
-
- this._pos = (pos ? (pos.length ? pos : [pos.pageX, pos.pageY]) : null);
- if (!this._pos) {
- var browserWidth = document.documentElement.clientWidth;
- var browserHeight = document.documentElement.clientHeight;
- var scrollX = document.documentElement.scrollLeft || document.body.scrollLeft;
- var scrollY = document.documentElement.scrollTop || document.body.scrollTop;
- this._pos = // should use actual width/height below
- [(browserWidth / 2) - 100 + scrollX, (browserHeight / 2) - 150 + scrollY];
- }
-
- // move input on screen for focus, but hidden behind dialog
- this._dialogInput.css('left', (this._pos[0] + 20) + 'px').css('top', this._pos[1] + 'px');
- inst.settings.onSelect = onSelect;
- this._inDialog = true;
- this.dpDiv.addClass(this._dialogClass);
- this._showDatepicker(this._dialogInput[0]);
- if ($.blockUI)
- $.blockUI(this.dpDiv);
- $.data(this._dialogInput[0], PROP_NAME, inst);
- return this;
- },
-
- /* Detach a datepicker from its control.
- @param target element - the target input field or division or span */
- _destroyDatepicker: function(target) {
- var $target = $(target);
- var inst = $.data(target, PROP_NAME);
- if (!$target.hasClass(this.markerClassName)) {
- return;
- }
- var nodeName = target.nodeName.toLowerCase();
- $.removeData(target, PROP_NAME);
- if (nodeName == 'input') {
- inst.append.remove();
- inst.trigger.remove();
- $target.removeClass(this.markerClassName).
- unbind('focus', this._showDatepicker).
- unbind('keydown', this._doKeyDown).
- unbind('keypress', this._doKeyPress).
- unbind('keyup', this._doKeyUp);
- } else if (nodeName == 'div' || nodeName == 'span')
- $target.removeClass(this.markerClassName).empty();
- },
-
- /* Enable the date picker to a jQuery selection.
- @param target element - the target input field or division or span */
- _enableDatepicker: function(target) {
- var $target = $(target);
- var inst = $.data(target, PROP_NAME);
- if (!$target.hasClass(this.markerClassName)) {
- return;
- }
- var nodeName = target.nodeName.toLowerCase();
- if (nodeName == 'input') {
- target.disabled = false;
- inst.trigger.filter('button').
- each(function() { this.disabled = false; }).end().
- filter('img').css({opacity: '1.0', cursor: ''});
- }
- else if (nodeName == 'div' || nodeName == 'span') {
- var inline = $target.children('.' + this._inlineClass);
- inline.children().removeClass('ui-state-disabled');
- inline.find("select.ui-datepicker-month, select.ui-datepicker-year").
- removeAttr("disabled");
- }
- this._disabledInputs = $.map(this._disabledInputs,
- function(value) { return (value == target ? null : value); }); // delete entry
- },
-
- /* Disable the date picker to a jQuery selection.
- @param target element - the target input field or division or span */
- _disableDatepicker: function(target) {
- var $target = $(target);
- var inst = $.data(target, PROP_NAME);
- if (!$target.hasClass(this.markerClassName)) {
- return;
- }
- var nodeName = target.nodeName.toLowerCase();
- if (nodeName == 'input') {
- target.disabled = true;
- inst.trigger.filter('button').
- each(function() { this.disabled = true; }).end().
- filter('img').css({opacity: '0.5', cursor: 'default'});
- }
- else if (nodeName == 'div' || nodeName == 'span') {
- var inline = $target.children('.' + this._inlineClass);
- inline.children().addClass('ui-state-disabled');
- inline.find("select.ui-datepicker-month, select.ui-datepicker-year").
- attr("disabled", "disabled");
- }
- this._disabledInputs = $.map(this._disabledInputs,
- function(value) { return (value == target ? null : value); }); // delete entry
- this._disabledInputs[this._disabledInputs.length] = target;
- },
-
- /* Is the first field in a jQuery collection disabled as a datepicker?
- @param target element - the target input field or division or span
- @return boolean - true if disabled, false if enabled */
- _isDisabledDatepicker: function(target) {
- if (!target) {
- return false;
- }
- for (var i = 0; i < this._disabledInputs.length; i++) {
- if (this._disabledInputs[i] == target)
- return true;
- }
- return false;
- },
-
- /* Retrieve the instance data for the target control.
- @param target element - the target input field or division or span
- @return object - the associated instance data
- @throws error if a jQuery problem getting data */
- _getInst: function(target) {
- try {
- return $.data(target, PROP_NAME);
- }
- catch (err) {
- throw 'Missing instance data for this datepicker';
- }
- },
-
- /* Update or retrieve the settings for a date picker attached to an input field or division.
- @param target element - the target input field or division or span
- @param name object - the new settings to update or
- string - the name of the setting to change or retrieve,
- when retrieving also 'all' for all instance settings or
- 'defaults' for all global defaults
- @param value any - the new value for the setting
- (omit if above is an object or to retrieve a value) */
- _optionDatepicker: function(target, name, value) {
- var inst = this._getInst(target);
- if (arguments.length == 2 && typeof name == 'string') {
- return (name == 'defaults' ? $.extend({}, $.datepicker._defaults) :
- (inst ? (name == 'all' ? $.extend({}, inst.settings) :
- this._get(inst, name)) : null));
- }
- var settings = name || {};
- if (typeof name == 'string') {
- settings = {};
- settings[name] = value;
- }
- if (inst) {
- if (this._curInst == inst) {
- this._hideDatepicker();
- }
- var date = this._getDateDatepicker(target, true);
- var minDate = this._getMinMaxDate(inst, 'min');
- var maxDate = this._getMinMaxDate(inst, 'max');
- extendRemove(inst.settings, settings);
- // reformat the old minDate/maxDate values if dateFormat changes and a new minDate/maxDate isn't provided
- if (minDate !== null && settings['dateFormat'] !== undefined && settings['minDate'] === undefined)
- inst.settings.minDate = this._formatDate(inst, minDate);
- if (maxDate !== null && settings['dateFormat'] !== undefined && settings['maxDate'] === undefined)
- inst.settings.maxDate = this._formatDate(inst, maxDate);
- this._attachments($(target), inst);
- this._autoSize(inst);
- this._setDate(inst, date);
- this._updateAlternate(inst);
- this._updateDatepicker(inst);
- }
- },
-
- // change method deprecated
- _changeDatepicker: function(target, name, value) {
- this._optionDatepicker(target, name, value);
- },
-
- /* Redraw the date picker attached to an input field or division.
- @param target element - the target input field or division or span */
- _refreshDatepicker: function(target) {
- var inst = this._getInst(target);
- if (inst) {
- this._updateDatepicker(inst);
- }
- },
-
- /* Set the dates for a jQuery selection.
- @param target element - the target input field or division or span
- @param date Date - the new date */
- _setDateDatepicker: function(target, date) {
- var inst = this._getInst(target);
- if (inst) {
- this._setDate(inst, date);
- this._updateDatepicker(inst);
- this._updateAlternate(inst);
- }
- },
-
- /* Get the date(s) for the first entry in a jQuery selection.
- @param target element - the target input field or division or span
- @param noDefault boolean - true if no default date is to be used
- @return Date - the current date */
- _getDateDatepicker: function(target, noDefault) {
- var inst = this._getInst(target);
- if (inst && !inst.inline)
- this._setDateFromField(inst, noDefault);
- return (inst ? this._getDate(inst) : null);
- },
-
- /* Handle keystrokes. */
- _doKeyDown: function(event) {
- var inst = $.datepicker._getInst(event.target);
- var handled = true;
- var isRTL = inst.dpDiv.is('.ui-datepicker-rtl');
- inst._keyEvent = true;
- if ($.datepicker._datepickerShowing)
- switch (event.keyCode) {
- case 9: $.datepicker._hideDatepicker();
- handled = false;
- break; // hide on tab out
- case 13: var sel = $('td.' + $.datepicker._dayOverClass + ':not(.' +
- $.datepicker._currentClass + ')', inst.dpDiv);
- if (sel[0])
- $.datepicker._selectDay(event.target, inst.selectedMonth, inst.selectedYear, sel[0]);
- else
- $.datepicker._hideDatepicker();
- return false; // don't submit the form
- break; // select the value on enter
- case 27: $.datepicker._hideDatepicker();
- break; // hide on escape
- case 33: $.datepicker._adjustDate(event.target, (event.ctrlKey ?
- -$.datepicker._get(inst, 'stepBigMonths') :
- -$.datepicker._get(inst, 'stepMonths')), 'M');
- break; // previous month/year on page up/+ ctrl
- case 34: $.datepicker._adjustDate(event.target, (event.ctrlKey ?
- +$.datepicker._get(inst, 'stepBigMonths') :
- +$.datepicker._get(inst, 'stepMonths')), 'M');
- break; // next month/year on page down/+ ctrl
- case 35: if (event.ctrlKey || event.metaKey) $.datepicker._clearDate(event.target);
- handled = event.ctrlKey || event.metaKey;
- break; // clear on ctrl or command +end
- case 36: if (event.ctrlKey || event.metaKey) $.datepicker._gotoToday(event.target);
- handled = event.ctrlKey || event.metaKey;
- break; // current on ctrl or command +home
- case 37: if (event.ctrlKey || event.metaKey) $.datepicker._adjustDate(event.target, (isRTL ? +1 : -1), 'D');
- handled = event.ctrlKey || event.metaKey;
- // -1 day on ctrl or command +left
- if (event.originalEvent.altKey) $.datepicker._adjustDate(event.target, (event.ctrlKey ?
- -$.datepicker._get(inst, 'stepBigMonths') :
- -$.datepicker._get(inst, 'stepMonths')), 'M');
- // next month/year on alt +left on Mac
- break;
- case 38: if (event.ctrlKey || event.metaKey) $.datepicker._adjustDate(event.target, -7, 'D');
- handled = event.ctrlKey || event.metaKey;
- break; // -1 week on ctrl or command +up
- case 39: if (event.ctrlKey || event.metaKey) $.datepicker._adjustDate(event.target, (isRTL ? -1 : +1), 'D');
- handled = event.ctrlKey || event.metaKey;
- // +1 day on ctrl or command +right
- if (event.originalEvent.altKey) $.datepicker._adjustDate(event.target, (event.ctrlKey ?
- +$.datepicker._get(inst, 'stepBigMonths') :
- +$.datepicker._get(inst, 'stepMonths')), 'M');
- // next month/year on alt +right
- break;
- case 40: if (event.ctrlKey || event.metaKey) $.datepicker._adjustDate(event.target, +7, 'D');
- handled = event.ctrlKey || event.metaKey;
- break; // +1 week on ctrl or command +down
- default: handled = false;
- }
- else if (event.keyCode == 36 && event.ctrlKey) // display the date picker on ctrl+home
- $.datepicker._showDatepicker(this);
- else {
- handled = false;
- }
- if (handled) {
- event.preventDefault();
- event.stopPropagation();
- }
- },
-
- /* Filter entered characters - based on date format. */
- _doKeyPress: function(event) {
- var inst = $.datepicker._getInst(event.target);
- if ($.datepicker._get(inst, 'constrainInput')) {
- var chars = $.datepicker._possibleChars($.datepicker._get(inst, 'dateFormat'));
- var chr = String.fromCharCode(event.charCode == undefined ? event.keyCode : event.charCode);
- return event.ctrlKey || event.metaKey || (chr < ' ' || !chars || chars.indexOf(chr) > -1);
- }
- },
-
- /* Synchronise manual entry and field/alternate field. */
- _doKeyUp: function(event) {
- var inst = $.datepicker._getInst(event.target);
- if (inst.input.val() != inst.lastVal) {
- try {
- var date = $.datepicker.parseDate($.datepicker._get(inst, 'dateFormat'),
- (inst.input ? inst.input.val() : null),
- $.datepicker._getFormatConfig(inst));
- if (date) { // only if valid
- $.datepicker._setDateFromField(inst);
- $.datepicker._updateAlternate(inst);
- $.datepicker._updateDatepicker(inst);
- }
- }
- catch (event) {
- $.datepicker.log(event);
- }
- }
- return true;
- },
-
- /* Pop-up the date picker for a given input field.
- @param input element - the input field attached to the date picker or
- event - if triggered by focus */
- _showDatepicker: function(input) {
- input = input.target || input;
- if (input.nodeName.toLowerCase() != 'input') // find from button/image trigger
- input = $('input', input.parentNode)[0];
- if ($.datepicker._isDisabledDatepicker(input) || $.datepicker._lastInput == input) // already here
- return;
- var inst = $.datepicker._getInst(input);
- if ($.datepicker._curInst && $.datepicker._curInst != inst) {
- if ( $.datepicker._datepickerShowing ) {
- $.datepicker._triggerOnClose($.datepicker._curInst);
- }
- $.datepicker._curInst.dpDiv.stop(true, true);
- }
- var beforeShow = $.datepicker._get(inst, 'beforeShow');
- extendRemove(inst.settings, (beforeShow ? beforeShow.apply(input, [input, inst]) : {}));
- inst.lastVal = null;
- $.datepicker._lastInput = input;
- $.datepicker._setDateFromField(inst);
- if ($.datepicker._inDialog) // hide cursor
- input.value = '';
- if (!$.datepicker._pos) { // position below input
- $.datepicker._pos = $.datepicker._findPos(input);
- $.datepicker._pos[1] += input.offsetHeight; // add the height
- }
- var isFixed = false;
- $(input).parents().each(function() {
- isFixed |= $(this).css('position') == 'fixed';
- return !isFixed;
- });
- if (isFixed && $.browser.opera) { // correction for Opera when fixed and scrolled
- $.datepicker._pos[0] -= document.documentElement.scrollLeft;
- $.datepicker._pos[1] -= document.documentElement.scrollTop;
- }
- var offset = {left: $.datepicker._pos[0], top: $.datepicker._pos[1]};
- $.datepicker._pos = null;
- //to avoid flashes on Firefox
- inst.dpDiv.empty();
- // determine sizing offscreen
- inst.dpDiv.css({position: 'absolute', display: 'block', top: '-1000px'});
- $.datepicker._updateDatepicker(inst);
- // fix width for dynamic number of date pickers
- // and adjust position before showing
- offset = $.datepicker._checkOffset(inst, offset, isFixed);
- inst.dpDiv.css({position: ($.datepicker._inDialog && $.blockUI ?
- 'static' : (isFixed ? 'fixed' : 'absolute')), display: 'none',
- left: offset.left + 'px', top: offset.top + 'px'});
- if (!inst.inline) {
- var showAnim = $.datepicker._get(inst, 'showAnim');
- var duration = $.datepicker._get(inst, 'duration');
- var postProcess = function() {
- var cover = inst.dpDiv.find('iframe.ui-datepicker-cover'); // IE6- only
- if( !! cover.length ){
- var borders = $.datepicker._getBorders(inst.dpDiv);
- cover.css({left: -borders[0], top: -borders[1],
- width: inst.dpDiv.outerWidth(), height: inst.dpDiv.outerHeight()});
- }
- };
- inst.dpDiv.zIndex($(input).zIndex()+1);
- $.datepicker._datepickerShowing = true;
- if ($.effects && $.effects[showAnim])
- inst.dpDiv.show(showAnim, $.datepicker._get(inst, 'showOptions'), duration, postProcess);
- else
- inst.dpDiv[showAnim || 'show']((showAnim ? duration : null), postProcess);
- if (!showAnim || !duration)
- postProcess();
- if (inst.input.is(':visible') && !inst.input.is(':disabled'))
- inst.input.focus();
- $.datepicker._curInst = inst;
- }
- },
-
- /* Generate the date picker content. */
- _updateDatepicker: function(inst) {
- var self = this;
- self.maxRows = 4; //Reset the max number of rows being displayed (see #7043)
- var borders = $.datepicker._getBorders(inst.dpDiv);
- instActive = inst; // for delegate hover events
- inst.dpDiv.empty().append(this._generateHTML(inst));
- var cover = inst.dpDiv.find('iframe.ui-datepicker-cover'); // IE6- only
- if( !!cover.length ){ //avoid call to outerXXXX() when not in IE6
- cover.css({left: -borders[0], top: -borders[1], width: inst.dpDiv.outerWidth(), height: inst.dpDiv.outerHeight()})
- }
- inst.dpDiv.find('.' + this._dayOverClass + ' a').mouseover();
- var numMonths = this._getNumberOfMonths(inst);
- var cols = numMonths[1];
- var width = 17;
- inst.dpDiv.removeClass('ui-datepicker-multi-2 ui-datepicker-multi-3 ui-datepicker-multi-4').width('');
- if (cols > 1)
- inst.dpDiv.addClass('ui-datepicker-multi-' + cols).css('width', (width * cols) + 'em');
- inst.dpDiv[(numMonths[0] != 1 || numMonths[1] != 1 ? 'add' : 'remove') +
- 'Class']('ui-datepicker-multi');
- inst.dpDiv[(this._get(inst, 'isRTL') ? 'add' : 'remove') +
- 'Class']('ui-datepicker-rtl');
- if (inst == $.datepicker._curInst && $.datepicker._datepickerShowing && inst.input &&
- // #6694 - don't focus the input if it's already focused
- // this breaks the change event in IE
- inst.input.is(':visible') && !inst.input.is(':disabled') && inst.input[0] != document.activeElement)
- inst.input.focus();
- // deffered render of the years select (to avoid flashes on Firefox)
- if( inst.yearshtml ){
- var origyearshtml = inst.yearshtml;
- setTimeout(function(){
- //assure that inst.yearshtml didn't change.
- if( origyearshtml === inst.yearshtml && inst.yearshtml ){
- inst.dpDiv.find('select.ui-datepicker-year:first').replaceWith(inst.yearshtml);
- }
- origyearshtml = inst.yearshtml = null;
- }, 0);
- }
- },
-
- /* Retrieve the size of left and top borders for an element.
- @param elem (jQuery object) the element of interest
- @return (number[2]) the left and top borders */
- _getBorders: function(elem) {
- var convert = function(value) {
- return {thin: 1, medium: 2, thick: 3}[value] || value;
- };
- return [parseFloat(convert(elem.css('border-left-width'))),
- parseFloat(convert(elem.css('border-top-width')))];
- },
-
- /* Check positioning to remain on screen. */
- _checkOffset: function(inst, offset, isFixed) {
- var dpWidth = inst.dpDiv.outerWidth();
- var dpHeight = inst.dpDiv.outerHeight();
- var inputWidth = inst.input ? inst.input.outerWidth() : 0;
- var inputHeight = inst.input ? inst.input.outerHeight() : 0;
- var viewWidth = document.documentElement.clientWidth + $(document).scrollLeft();
- var viewHeight = document.documentElement.clientHeight + $(document).scrollTop();
-
- offset.left -= (this._get(inst, 'isRTL') ? (dpWidth - inputWidth) : 0);
- offset.left -= (isFixed && offset.left == inst.input.offset().left) ? $(document).scrollLeft() : 0;
- offset.top -= (isFixed && offset.top == (inst.input.offset().top + inputHeight)) ? $(document).scrollTop() : 0;
-
- // now check if datepicker is showing outside window viewport - move to a better place if so.
- offset.left -= Math.min(offset.left, (offset.left + dpWidth > viewWidth && viewWidth > dpWidth) ?
- Math.abs(offset.left + dpWidth - viewWidth) : 0);
- offset.top -= Math.min(offset.top, (offset.top + dpHeight > viewHeight && viewHeight > dpHeight) ?
- Math.abs(dpHeight + inputHeight) : 0);
-
- return offset;
- },
-
- /* Find an object's position on the screen. */
- _findPos: function(obj) {
- var inst = this._getInst(obj);
- var isRTL = this._get(inst, 'isRTL');
- while (obj && (obj.type == 'hidden' || obj.nodeType != 1 || $.expr.filters.hidden(obj))) {
- obj = obj[isRTL ? 'previousSibling' : 'nextSibling'];
- }
- var position = $(obj).offset();
- return [position.left, position.top];
- },
-
- /* Trigger custom callback of onClose. */
- _triggerOnClose: function(inst) {
- var onClose = this._get(inst, 'onClose');
- if (onClose)
- onClose.apply((inst.input ? inst.input[0] : null),
- [(inst.input ? inst.input.val() : ''), inst]);
- },
-
- /* Hide the date picker from view.
- @param input element - the input field attached to the date picker */
- _hideDatepicker: function(input) {
- var inst = this._curInst;
- if (!inst || (input && inst != $.data(input, PROP_NAME)))
- return;
- if (this._datepickerShowing) {
- var showAnim = this._get(inst, 'showAnim');
- var duration = this._get(inst, 'duration');
- var postProcess = function() {
- $.datepicker._tidyDialog(inst);
- this._curInst = null;
- };
- if ($.effects && $.effects[showAnim])
- inst.dpDiv.hide(showAnim, $.datepicker._get(inst, 'showOptions'), duration, postProcess);
- else
- inst.dpDiv[(showAnim == 'slideDown' ? 'slideUp' :
- (showAnim == 'fadeIn' ? 'fadeOut' : 'hide'))]((showAnim ? duration : null), postProcess);
- if (!showAnim)
- postProcess();
- $.datepicker._triggerOnClose(inst);
- this._datepickerShowing = false;
- this._lastInput = null;
- if (this._inDialog) {
- this._dialogInput.css({ position: 'absolute', left: '0', top: '-100px' });
- if ($.blockUI) {
- $.unblockUI();
- $('body').append(this.dpDiv);
- }
- }
- this._inDialog = false;
- }
- },
-
- /* Tidy up after a dialog display. */
- _tidyDialog: function(inst) {
- inst.dpDiv.removeClass(this._dialogClass).unbind('.ui-datepicker-calendar');
- },
-
- /* Close date picker if clicked elsewhere. */
- _checkExternalClick: function(event) {
- if (!$.datepicker._curInst)
- return;
- var $target = $(event.target);
- if ($target[0].id != $.datepicker._mainDivId &&
- $target.parents('#' + $.datepicker._mainDivId).length == 0 &&
- !$target.hasClass($.datepicker.markerClassName) &&
- !$target.hasClass($.datepicker._triggerClass) &&
- $.datepicker._datepickerShowing && !($.datepicker._inDialog && $.blockUI))
- $.datepicker._hideDatepicker();
- },
-
- /* Adjust one of the date sub-fields. */
- _adjustDate: function(id, offset, period) {
- var target = $(id);
- var inst = this._getInst(target[0]);
- if (this._isDisabledDatepicker(target[0])) {
- return;
- }
- this._adjustInstDate(inst, offset +
- (period == 'M' ? this._get(inst, 'showCurrentAtPos') : 0), // undo positioning
- period);
- this._updateDatepicker(inst);
- },
-
- /* Action for current link. */
- _gotoToday: function(id) {
- var target = $(id);
- var inst = this._getInst(target[0]);
- if (this._get(inst, 'gotoCurrent') && inst.currentDay) {
- inst.selectedDay = inst.currentDay;
- inst.drawMonth = inst.selectedMonth = inst.currentMonth;
- inst.drawYear = inst.selectedYear = inst.currentYear;
- }
- else {
- var date = new Date();
- inst.selectedDay = date.getDate();
- inst.drawMonth = inst.selectedMonth = date.getMonth();
- inst.drawYear = inst.selectedYear = date.getFullYear();
- }
- this._notifyChange(inst);
- this._adjustDate(target);
- },
-
- /* Action for selecting a new month/year. */
- _selectMonthYear: function(id, select, period) {
- var target = $(id);
- var inst = this._getInst(target[0]);
- inst._selectingMonthYear = false;
- inst['selected' + (period == 'M' ? 'Month' : 'Year')] =
- inst['draw' + (period == 'M' ? 'Month' : 'Year')] =
- parseInt(select.options[select.selectedIndex].value,10);
- this._notifyChange(inst);
- this._adjustDate(target);
- },
-
- /* Restore input focus after not changing month/year. */
- _clickMonthYear: function(id) {
- var target = $(id);
- var inst = this._getInst(target[0]);
- if (inst.input && inst._selectingMonthYear) {
- setTimeout(function() {
- inst.input.focus();
- }, 0);
- }
- inst._selectingMonthYear = !inst._selectingMonthYear;
- },
-
- /* Action for selecting a day. */
- _selectDay: function(id, month, year, td) {
- var target = $(id);
- if ($(td).hasClass(this._unselectableClass) || this._isDisabledDatepicker(target[0])) {
- return;
- }
- var inst = this._getInst(target[0]);
- inst.selectedDay = inst.currentDay = $('a', td).html();
- inst.selectedMonth = inst.currentMonth = month;
- inst.selectedYear = inst.currentYear = year;
- this._selectDate(id, this._formatDate(inst,
- inst.currentDay, inst.currentMonth, inst.currentYear));
- },
-
- /* Erase the input field and hide the date picker. */
- _clearDate: function(id) {
- var target = $(id);
- var inst = this._getInst(target[0]);
- this._selectDate(target, '');
- },
-
- /* Update the input field with the selected date. */
- _selectDate: function(id, dateStr) {
- var target = $(id);
- var inst = this._getInst(target[0]);
- dateStr = (dateStr != null ? dateStr : this._formatDate(inst));
- if (inst.input)
- inst.input.val(dateStr);
- this._updateAlternate(inst);
- var onSelect = this._get(inst, 'onSelect');
- if (onSelect)
- onSelect.apply((inst.input ? inst.input[0] : null), [dateStr, inst]); // trigger custom callback
- else if (inst.input)
- inst.input.trigger('change'); // fire the change event
- if (inst.inline)
- this._updateDatepicker(inst);
- else {
- this._hideDatepicker();
- this._lastInput = inst.input[0];
- if (typeof(inst.input[0]) != 'object')
- inst.input.focus(); // restore focus
- this._lastInput = null;
- }
- },
-
- /* Update any alternate field to synchronise with the main field. */
- _updateAlternate: function(inst) {
- var altField = this._get(inst, 'altField');
- if (altField) { // update alternate field too
- var altFormat = this._get(inst, 'altFormat') || this._get(inst, 'dateFormat');
- var date = this._getDate(inst);
- var dateStr = this.formatDate(altFormat, date, this._getFormatConfig(inst));
- $(altField).each(function() { $(this).val(dateStr); });
- }
- },
-
- /* Set as beforeShowDay function to prevent selection of weekends.
- @param date Date - the date to customise
- @return [boolean, string] - is this date selectable?, what is its CSS class? */
- noWeekends: function(date) {
- var day = date.getDay();
- return [(day > 0 && day < 6), ''];
- },
-
- /* Set as calculateWeek to determine the week of the year based on the ISO 8601 definition.
- @param date Date - the date to get the week for
- @return number - the number of the week within the year that contains this date */
- iso8601Week: function(date) {
- var checkDate = new Date(date.getTime());
- // Find Thursday of this week starting on Monday
- checkDate.setDate(checkDate.getDate() + 4 - (checkDate.getDay() || 7));
- var time = checkDate.getTime();
- checkDate.setMonth(0); // Compare with Jan 1
- checkDate.setDate(1);
- return Math.floor(Math.round((time - checkDate) / 86400000) / 7) + 1;
- },
-
- /* Parse a string value into a date object.
- See formatDate below for the possible formats.
-
- @param format string - the expected format of the date
- @param value string - the date in the above format
- @param settings Object - attributes include:
- shortYearCutoff number - the cutoff year for determining the century (optional)
- dayNamesShort string[7] - abbreviated names of the days from Sunday (optional)
- dayNames string[7] - names of the days from Sunday (optional)
- monthNamesShort string[12] - abbreviated names of the months (optional)
- monthNames string[12] - names of the months (optional)
- @return Date - the extracted date value or null if value is blank */
- parseDate: function (format, value, settings) {
- if (format == null || value == null)
- throw 'Invalid arguments';
- value = (typeof value == 'object' ? value.toString() : value + '');
- if (value == '')
- return null;
- var shortYearCutoff = (settings ? settings.shortYearCutoff : null) || this._defaults.shortYearCutoff;
- shortYearCutoff = (typeof shortYearCutoff != 'string' ? shortYearCutoff :
- new Date().getFullYear() % 100 + parseInt(shortYearCutoff, 10));
- var dayNamesShort = (settings ? settings.dayNamesShort : null) || this._defaults.dayNamesShort;
- var dayNames = (settings ? settings.dayNames : null) || this._defaults.dayNames;
- var monthNamesShort = (settings ? settings.monthNamesShort : null) || this._defaults.monthNamesShort;
- var monthNames = (settings ? settings.monthNames : null) || this._defaults.monthNames;
- var year = -1;
- var month = -1;
- var day = -1;
- var doy = -1;
- var literal = false;
- // Check whether a format character is doubled
- var lookAhead = function(match) {
- var matches = (iFormat + 1 < format.length && format.charAt(iFormat + 1) == match);
- if (matches)
- iFormat++;
- return matches;
- };
- // Extract a number from the string value
- var getNumber = function(match) {
- var isDoubled = lookAhead(match);
- var size = (match == '@' ? 14 : (match == '!' ? 20 :
- (match == 'y' && isDoubled ? 4 : (match == 'o' ? 3 : 2))));
- var digits = new RegExp('^\\d{1,' + size + '}');
- var num = value.substring(iValue).match(digits);
- if (!num)
- throw 'Missing number at position ' + iValue;
- iValue += num[0].length;
- return parseInt(num[0], 10);
- };
- // Extract a name from the string value and convert to an index
- var getName = function(match, shortNames, longNames) {
- var names = $.map(lookAhead(match) ? longNames : shortNames, function (v, k) {
- return [ [k, v] ];
- }).sort(function (a, b) {
- return -(a[1].length - b[1].length);
- });
- var index = -1;
- $.each(names, function (i, pair) {
- var name = pair[1];
- if (value.substr(iValue, name.length).toLowerCase() == name.toLowerCase()) {
- index = pair[0];
- iValue += name.length;
- return false;
- }
- });
- if (index != -1)
- return index + 1;
- else
- throw 'Unknown name at position ' + iValue;
- };
- // Confirm that a literal character matches the string value
- var checkLiteral = function() {
- if (value.charAt(iValue) != format.charAt(iFormat))
- throw 'Unexpected literal at position ' + iValue;
- iValue++;
- };
- var iValue = 0;
- for (var iFormat = 0; iFormat < format.length; iFormat++) {
- if (literal)
- if (format.charAt(iFormat) == "'" && !lookAhead("'"))
- literal = false;
- else
- checkLiteral();
- else
- switch (format.charAt(iFormat)) {
- case 'd':
- day = getNumber('d');
- break;
- case 'D':
- getName('D', dayNamesShort, dayNames);
- break;
- case 'o':
- doy = getNumber('o');
- break;
- case 'm':
- month = getNumber('m');
- break;
- case 'M':
- month = getName('M', monthNamesShort, monthNames);
- break;
- case 'y':
- year = getNumber('y');
- break;
- case '@':
- var date = new Date(getNumber('@'));
- year = date.getFullYear();
- month = date.getMonth() + 1;
- day = date.getDate();
- break;
- case '!':
- var date = new Date((getNumber('!') - this._ticksTo1970) / 10000);
- year = date.getFullYear();
- month = date.getMonth() + 1;
- day = date.getDate();
- break;
- case "'":
- if (lookAhead("'"))
- checkLiteral();
- else
- literal = true;
- break;
- default:
- checkLiteral();
- }
- }
- if (iValue < value.length){
- throw "Extra/unparsed characters found in date: " + value.substring(iValue);
- }
- if (year == -1)
- year = new Date().getFullYear();
- else if (year < 100)
- year += new Date().getFullYear() - new Date().getFullYear() % 100 +
- (year <= shortYearCutoff ? 0 : -100);
- if (doy > -1) {
- month = 1;
- day = doy;
- do {
- var dim = this._getDaysInMonth(year, month - 1);
- if (day <= dim)
- break;
- month++;
- day -= dim;
- } while (true);
- }
- var date = this._daylightSavingAdjust(new Date(year, month - 1, day));
- if (date.getFullYear() != year || date.getMonth() + 1 != month || date.getDate() != day)
- throw 'Invalid date'; // E.g. 31/02/00
- return date;
- },
-
- /* Standard date formats. */
- ATOM: 'yy-mm-dd', // RFC 3339 (ISO 8601)
- COOKIE: 'D, dd M yy',
- ISO_8601: 'yy-mm-dd',
- RFC_822: 'D, d M y',
- RFC_850: 'DD, dd-M-y',
- RFC_1036: 'D, d M y',
- RFC_1123: 'D, d M yy',
- RFC_2822: 'D, d M yy',
- RSS: 'D, d M y', // RFC 822
- TICKS: '!',
- TIMESTAMP: '@',
- W3C: 'yy-mm-dd', // ISO 8601
-
- _ticksTo1970: (((1970 - 1) * 365 + Math.floor(1970 / 4) - Math.floor(1970 / 100) +
- Math.floor(1970 / 400)) * 24 * 60 * 60 * 10000000),
-
- /* Format a date object into a string value.
- The format can be combinations of the following:
- d - day of month (no leading zero)
- dd - day of month (two digit)
- o - day of year (no leading zeros)
- oo - day of year (three digit)
- D - day name short
- DD - day name long
- m - month of year (no leading zero)
- mm - month of year (two digit)
- M - month name short
- MM - month name long
- y - year (two digit)
- yy - year (four digit)
- @ - Unix timestamp (ms since 01/01/1970)
- ! - Windows ticks (100ns since 01/01/0001)
- '...' - literal text
- '' - single quote
-
- @param format string - the desired format of the date
- @param date Date - the date value to format
- @param settings Object - attributes include:
- dayNamesShort string[7] - abbreviated names of the days from Sunday (optional)
- dayNames string[7] - names of the days from Sunday (optional)
- monthNamesShort string[12] - abbreviated names of the months (optional)
- monthNames string[12] - names of the months (optional)
- @return string - the date in the above format */
- formatDate: function (format, date, settings) {
- if (!date)
- return '';
- var dayNamesShort = (settings ? settings.dayNamesShort : null) || this._defaults.dayNamesShort;
- var dayNames = (settings ? settings.dayNames : null) || this._defaults.dayNames;
- var monthNamesShort = (settings ? settings.monthNamesShort : null) || this._defaults.monthNamesShort;
- var monthNames = (settings ? settings.monthNames : null) || this._defaults.monthNames;
- // Check whether a format character is doubled
- var lookAhead = function(match) {
- var matches = (iFormat + 1 < format.length && format.charAt(iFormat + 1) == match);
- if (matches)
- iFormat++;
- return matches;
- };
- // Format a number, with leading zero if necessary
- var formatNumber = function(match, value, len) {
- var num = '' + value;
- if (lookAhead(match))
- while (num.length < len)
- num = '0' + num;
- return num;
- };
- // Format a name, short or long as requested
- var formatName = function(match, value, shortNames, longNames) {
- return (lookAhead(match) ? longNames[value] : shortNames[value]);
- };
- var output = '';
- var literal = false;
- if (date)
- for (var iFormat = 0; iFormat < format.length; iFormat++) {
- if (literal)
- if (format.charAt(iFormat) == "'" && !lookAhead("'"))
- literal = false;
- else
- output += format.charAt(iFormat);
- else
- switch (format.charAt(iFormat)) {
- case 'd':
- output += formatNumber('d', date.getDate(), 2);
- break;
- case 'D':
- output += formatName('D', date.getDay(), dayNamesShort, dayNames);
- break;
- case 'o':
- output += formatNumber('o',
- Math.round((new Date(date.getFullYear(), date.getMonth(), date.getDate()).getTime() - new Date(date.getFullYear(), 0, 0).getTime()) / 86400000), 3);
- break;
- case 'm':
- output += formatNumber('m', date.getMonth() + 1, 2);
- break;
- case 'M':
- output += formatName('M', date.getMonth(), monthNamesShort, monthNames);
- break;
- case 'y':
- output += (lookAhead('y') ? date.getFullYear() :
- (date.getYear() % 100 < 10 ? '0' : '') + date.getYear() % 100);
- break;
- case '@':
- output += date.getTime();
- break;
- case '!':
- output += date.getTime() * 10000 + this._ticksTo1970;
- break;
- case "'":
- if (lookAhead("'"))
- output += "'";
- else
- literal = true;
- break;
- default:
- output += format.charAt(iFormat);
- }
- }
- return output;
- },
-
- /* Extract all possible characters from the date format. */
- _possibleChars: function (format) {
- var chars = '';
- var literal = false;
- // Check whether a format character is doubled
- var lookAhead = function(match) {
- var matches = (iFormat + 1 < format.length && format.charAt(iFormat + 1) == match);
- if (matches)
- iFormat++;
- return matches;
- };
- for (var iFormat = 0; iFormat < format.length; iFormat++)
- if (literal)
- if (format.charAt(iFormat) == "'" && !lookAhead("'"))
- literal = false;
- else
- chars += format.charAt(iFormat);
- else
- switch (format.charAt(iFormat)) {
- case 'd': case 'm': case 'y': case '@':
- chars += '0123456789';
- break;
- case 'D': case 'M':
- return null; // Accept anything
- case "'":
- if (lookAhead("'"))
- chars += "'";
- else
- literal = true;
- break;
- default:
- chars += format.charAt(iFormat);
- }
- return chars;
- },
-
- /* Get a setting value, defaulting if necessary. */
- _get: function(inst, name) {
- return inst.settings[name] !== undefined ?
- inst.settings[name] : this._defaults[name];
- },
-
- /* Parse existing date and initialise date picker. */
- _setDateFromField: function(inst, noDefault) {
- if (inst.input.val() == inst.lastVal) {
- return;
- }
- var dateFormat = this._get(inst, 'dateFormat');
- var dates = inst.lastVal = inst.input ? inst.input.val() : null;
- var date, defaultDate;
- date = defaultDate = this._getDefaultDate(inst);
- var settings = this._getFormatConfig(inst);
- try {
- date = this.parseDate(dateFormat, dates, settings) || defaultDate;
- } catch (event) {
- this.log(event);
- dates = (noDefault ? '' : dates);
- }
- inst.selectedDay = date.getDate();
- inst.drawMonth = inst.selectedMonth = date.getMonth();
- inst.drawYear = inst.selectedYear = date.getFullYear();
- inst.currentDay = (dates ? date.getDate() : 0);
- inst.currentMonth = (dates ? date.getMonth() : 0);
- inst.currentYear = (dates ? date.getFullYear() : 0);
- this._adjustInstDate(inst);
- },
-
- /* Retrieve the default date shown on opening. */
- _getDefaultDate: function(inst) {
- return this._restrictMinMax(inst,
- this._determineDate(inst, this._get(inst, 'defaultDate'), new Date()));
- },
-
- /* A date may be specified as an exact value or a relative one. */
- _determineDate: function(inst, date, defaultDate) {
- var offsetNumeric = function(offset) {
- var date = new Date();
- date.setDate(date.getDate() + offset);
- return date;
- };
- var offsetString = function(offset) {
- try {
- return $.datepicker.parseDate($.datepicker._get(inst, 'dateFormat'),
- offset, $.datepicker._getFormatConfig(inst));
- }
- catch (e) {
- // Ignore
- }
- var date = (offset.toLowerCase().match(/^c/) ?
- $.datepicker._getDate(inst) : null) || new Date();
- var year = date.getFullYear();
- var month = date.getMonth();
- var day = date.getDate();
- var pattern = /([+-]?[0-9]+)\s*(d|D|w|W|m|M|y|Y)?/g;
- var matches = pattern.exec(offset);
- while (matches) {
- switch (matches[2] || 'd') {
- case 'd' : case 'D' :
- day += parseInt(matches[1],10); break;
- case 'w' : case 'W' :
- day += parseInt(matches[1],10) * 7; break;
- case 'm' : case 'M' :
- month += parseInt(matches[1],10);
- day = Math.min(day, $.datepicker._getDaysInMonth(year, month));
- break;
- case 'y': case 'Y' :
- year += parseInt(matches[1],10);
- day = Math.min(day, $.datepicker._getDaysInMonth(year, month));
- break;
- }
- matches = pattern.exec(offset);
- }
- return new Date(year, month, day);
- };
- var newDate = (date == null || date === '' ? defaultDate : (typeof date == 'string' ? offsetString(date) :
- (typeof date == 'number' ? (isNaN(date) ? defaultDate : offsetNumeric(date)) : new Date(date.getTime()))));
- newDate = (newDate && newDate.toString() == 'Invalid Date' ? defaultDate : newDate);
- if (newDate) {
- newDate.setHours(0);
- newDate.setMinutes(0);
- newDate.setSeconds(0);
- newDate.setMilliseconds(0);
- }
- return this._daylightSavingAdjust(newDate);
- },
-
- /* Handle switch to/from daylight saving.
- Hours may be non-zero on daylight saving cut-over:
- > 12 when midnight changeover, but then cannot generate
- midnight datetime, so jump to 1AM, otherwise reset.
- @param date (Date) the date to check
- @return (Date) the corrected date */
- _daylightSavingAdjust: function(date) {
- if (!date) return null;
- date.setHours(date.getHours() > 12 ? date.getHours() + 2 : 0);
- return date;
- },
-
- /* Set the date(s) directly. */
- _setDate: function(inst, date, noChange) {
- var clear = !date;
- var origMonth = inst.selectedMonth;
- var origYear = inst.selectedYear;
- var newDate = this._restrictMinMax(inst, this._determineDate(inst, date, new Date()));
- inst.selectedDay = inst.currentDay = newDate.getDate();
- inst.drawMonth = inst.selectedMonth = inst.currentMonth = newDate.getMonth();
- inst.drawYear = inst.selectedYear = inst.currentYear = newDate.getFullYear();
- if ((origMonth != inst.selectedMonth || origYear != inst.selectedYear) && !noChange)
- this._notifyChange(inst);
- this._adjustInstDate(inst);
- if (inst.input) {
- inst.input.val(clear ? '' : this._formatDate(inst));
- }
- },
-
- /* Retrieve the date(s) directly. */
- _getDate: function(inst) {
- var startDate = (!inst.currentYear || (inst.input && inst.input.val() == '') ? null :
- this._daylightSavingAdjust(new Date(
- inst.currentYear, inst.currentMonth, inst.currentDay)));
- return startDate;
- },
-
- /* Generate the HTML for the current state of the date picker. */
- _generateHTML: function(inst) {
- var today = new Date();
- today = this._daylightSavingAdjust(
- new Date(today.getFullYear(), today.getMonth(), today.getDate())); // clear time
- var isRTL = this._get(inst, 'isRTL');
- var showButtonPanel = this._get(inst, 'showButtonPanel');
- var hideIfNoPrevNext = this._get(inst, 'hideIfNoPrevNext');
- var navigationAsDateFormat = this._get(inst, 'navigationAsDateFormat');
- var numMonths = this._getNumberOfMonths(inst);
- var showCurrentAtPos = this._get(inst, 'showCurrentAtPos');
- var stepMonths = this._get(inst, 'stepMonths');
- var isMultiMonth = (numMonths[0] != 1 || numMonths[1] != 1);
- var currentDate = this._daylightSavingAdjust((!inst.currentDay ? new Date(9999, 9, 9) :
- new Date(inst.currentYear, inst.currentMonth, inst.currentDay)));
- var minDate = this._getMinMaxDate(inst, 'min');
- var maxDate = this._getMinMaxDate(inst, 'max');
- var drawMonth = inst.drawMonth - showCurrentAtPos;
- var drawYear = inst.drawYear;
- if (drawMonth < 0) {
- drawMonth += 12;
- drawYear--;
- }
- if (maxDate) {
- var maxDraw = this._daylightSavingAdjust(new Date(maxDate.getFullYear(),
- maxDate.getMonth() - (numMonths[0] * numMonths[1]) + 1, maxDate.getDate()));
- maxDraw = (minDate && maxDraw < minDate ? minDate : maxDraw);
- while (this._daylightSavingAdjust(new Date(drawYear, drawMonth, 1)) > maxDraw) {
- drawMonth--;
- if (drawMonth < 0) {
- drawMonth = 11;
- drawYear--;
- }
- }
- }
- inst.drawMonth = drawMonth;
- inst.drawYear = drawYear;
- var prevText = this._get(inst, 'prevText');
- prevText = (!navigationAsDateFormat ? prevText : this.formatDate(prevText,
- this._daylightSavingAdjust(new Date(drawYear, drawMonth - stepMonths, 1)),
- this._getFormatConfig(inst)));
- var prev = (this._canAdjustMonth(inst, -1, drawYear, drawMonth) ?
- '' + prevText + '' :
- (hideIfNoPrevNext ? '' : '' + prevText + ''));
- var nextText = this._get(inst, 'nextText');
- nextText = (!navigationAsDateFormat ? nextText : this.formatDate(nextText,
- this._daylightSavingAdjust(new Date(drawYear, drawMonth + stepMonths, 1)),
- this._getFormatConfig(inst)));
- var next = (this._canAdjustMonth(inst, +1, drawYear, drawMonth) ?
- '' + nextText + '' :
- (hideIfNoPrevNext ? '' : '' + nextText + ''));
- var currentText = this._get(inst, 'currentText');
- var gotoDate = (this._get(inst, 'gotoCurrent') && inst.currentDay ? currentDate : today);
- currentText = (!navigationAsDateFormat ? currentText :
- this.formatDate(currentText, gotoDate, this._getFormatConfig(inst)));
- var controls = (!inst.inline ? '' : '');
- var buttonPanel = (showButtonPanel) ? '
- N - None
- O - One time fee
- D - Daily
- W - Weekly
- M - Monthly
- Y - Yearly
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the fee for the role
-
- A single number representing the fee for the role
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Trial Frequency for the role
-
- A String representing the Trial Frequency of the Role
-
- N - None
- O - One time fee
- D - Daily
- W - Weekly
- M - Monthly
- Y - Yearly
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the length of the trial period
-
- An integer representing the length of the trial period
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the length of the billing period
-
- An integer representing the length of the billing period
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the trial fee for the role
-
- A single number representing the trial fee for the role
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the role is public
-
- A boolean (True/False)
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether users are automatically assigned to the role
-
- A boolean (True/False)
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the RSVP Code for the role
-
- A string representing the RSVP Code for the role
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Icon File for the role
-
- A string representing the Icon File for the role
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a RoleInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 03/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 03/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an XmlSchema for the RoleInfo
-
-
- [cnurse] 03/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a RoleInfo from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 03/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes a RoleInfo to an XmlWriter
-
- The XmlWriter to use
-
- [cnurse] 03/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Security.Roles
- Class: RoleInfo
- -----------------------------------------------------------------------------
-
- The RoleInfo class provides the Entity Layer Role object
-
-
- [cnurse] 05/23/2005 made compatible with .NET 2.0
- [cnurse] 01/03/2006 added RoleGroupId property
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Auto Assign existing users to a role
-
- The Role to Auto assign
-
- [cnurse] 05/23/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This overload adds a role and optionally adds the info to the AspNet Roles
-
- The Role to Add
- The Id of the new role
-
- [cnurse] 05/23/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Delete a Role
-
- The Id of the Role to delete
- The Id of the Portal
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Get a list of roles for the Portal
-
- The Id of the Portal
- An ArrayList of RoleInfo objects
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fetch a single Role
-
- The Id of the Role
- The Id of the Portal
-
-
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Obtains a role given the role name
-
- Portal indentifier
- Name of the role to be found
- A RoleInfo object is the role is found
-
- [VMasanas] 27/08/2004 Created
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Returns an array of rolenames for a Portal
-
- The Id of the Portal
- A String Array of Role Names
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an ArrayList of Roles
-
- An ArrayList of Roles
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Get the roles for a Role Group
-
- Id of the portal
- Id of the Role Group (If -1 all roles for the portal are
- retrieved).
- An ArrayList of RoleInfo objects
-
- [cnurse] 01/03/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a List of Roles for a given User
-
- The Id of the User
- The Id of the Portal
- A String Array of Role Names
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Persists a role to the Data Store
-
- The role to persist
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a User to a Role
-
- The Id of the Portal
- The Id of the User
- The Id of the Role
- The expiry Date of the Role membership
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
- [cnurse] 05/12/2006 Now calls new overload with EffectiveDate = Now()
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a User to a Role
-
- Overload adds Effective Date
- The Id of the Portal
- The Id of the User
- The Id of the Role
- The expiry Date of the Role membership
- The expiry Date of the Role membership
-
- [cnurse] 05/12/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Delete/Remove a User from a Role
-
- The Id of the Portal
- The Id of the User
- The Id of the Role
-
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a User/Role
-
- The Id of the Portal
- The Id of the user
- The Id of the Role
- A UserRoleInfo object
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of UserRoles for a Portal
-
- The Id of the Portal
- An ArrayList of UserRoleInfo objects
-
- [Nik Kalyani] 10/15/2004 Created multiple signatures to eliminate Optional parameters
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of UserRoles for a User
-
- The Id of the Portal
- The Id of the User
- An ArrayList of UserRoleInfo objects
-
- [Nik Kalyani] 10/15/2004 Created multiple signatures to eliminate Optional parameters
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of UserRoles for a User
-
- The Id of the Portal
- The Id of the User
- An ArrayList of UserRoleInfo objects
-
- [Nik Kalyani] 10/15/2004 Created multiple signatures to eliminate Optional parameters
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a List of UserRoles by UserName and RoleName
-
- The Id of the Portal
- The username of the user
- The role name
- An ArrayList of UserRoleInfo objects
-
- [cnurse] 05/24/2005 Documented
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Get the users in a role (as UserRole objects)
-
- Id of the portal (If -1 all roles for all portals are
- retrieved.
- The role to fetch users for
- An ArrayList of UserRoleInfo objects
-
- [cnurse] 01/27/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Get the users in a role (as User objects)
-
- Id of the portal (If -1 all roles for all portals are
- retrieved.
- The role to fetch users for
- An ArrayList of UserInfo objects
-
- [cnurse] 01/27/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates a Service (UserRole)
-
- The Id of the Portal
- The Id of the User
- The Id of the Role
-
- [Nik Kalyani] 10/15/2004 Created multiple signatures to eliminate Optional parameters
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates a Service (UserRole)
-
- The Id of the Portal
- The Id of the User
- The Id of the Role
- A flag that indicates whether to cancel (delete) the userrole
-
- [Nik Kalyani] 10/15/2004 Created multiple signatures to eliminate Optional parameters
- [cnurse] 12/15/2005 Abstracted to MembershipProvider
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SendNotification sends an email notification to the user of the change in his/her role
-
-
-
- The User
- The Role
-
- [cnurse] 9/10/2004 Updated to reflect design changes for Help, 508 support
- and localisation
- [cnurse] 10/17/2007 Moved to RoleController
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a Role Group
-
- The RoleGroup to Add
- The Id of the new role
-
- [cnurse] 01/03/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a User to a Role
-
- The user to assign
- The role to add
- The PortalSettings of the Portal
- The expiry Date of the Role membership
- The expiry Date of the Role membership
- The Id of the User assigning the role
- A flag that indicates whether the user should be notified
-
- [cnurse] 10/17/2007 Created (Refactored code from Security Roles user control)
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Removes a User from a Role
-
- The Id of the user to remove
- The role to remove the use from
- The PortalSettings of the Portal
- A flag that indicates whether the user should be notified
-
- [cnurse] 10/17/2007 Created (Refactored code from Security Roles user control)
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Removes a User from a Role
-
- The Id of the role to remove the user from
- The user to remove
- The PortalSettings of the Portal
- A flag that indicates whether the user should be notified
-
- [cnurse] 10/17/2007 Created (Refactored code from Security Roles user control)
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Removes a User from a Role
-
- The user to remove
- The role to remove the use from
- The PortalSettings of the Portal
- A flag that indicates whether the user should be notified
-
- [cnurse] 10/17/2007 Created (Refactored code from Security Roles user control)
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Determines if the specified user can be removed from a role
-
-
- Roles such as "Registered Users" and "Administrators" can only
- be removed in certain circumstances
-
- A PortalSettings structure representing the current portal settings
- The Id of the User that should be checked for role removability
- The Id of the Role that should be checked for removability
-
-
- [anurse] 01/12/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Determines if the specified user can be removed from a role
-
-
- Roles such as "Registered Users" and "Administrators" can only
- be removed in certain circumstances
-
- A PortalInfo structure representing the current portal
- The Id of the User
- The Id of the Role that should be checked for removability
-
-
- [anurse] 01/12/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Deletes a Role Group
-
-
- [cnurse] 01/03/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Deletes a Role Group
-
- The RoleGroup to Delete
-
- [cnurse] 01/03/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fetch a single RoleGroup
-
- The Id of the Portal
-
-
-
- [cnurse] 01/03/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fetch a single RoleGroup by Name
-
- The Id of the Portal
-
-
-
- [cnurse] 01/03/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an ArrayList of RoleGroups
-
- The Id of the Portal
- An ArrayList of RoleGroups
-
- [cnurse] 01/03/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Serializes the role groups
-
- An XmlWriter
- The Id of the Portal
-
- [cnurse] 03/18/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Serializes the roles
-
- An XmlWriter
- The Id of the Portal
-
- [cnurse] 03/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates a Role Group
-
- The RoleGroup to Update
-
- [cnurse] 01/03/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Security.Roles
- Class: RoleController
- -----------------------------------------------------------------------------
-
- The RoleController class provides Business Layer methods for Roles
-
-
- [cnurse] 05/23/2005 made compatible with .NET 2.0
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Compares two RoleInfo objects by performing a comparison of their rolenames
-
- One of the items to compare
- One of the items to compare
- An Integer that determines whether x is greater, smaller or equal to y
-
- [cnurse] 05/24/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Security.Roles
- Class: RoleComparer
- -----------------------------------------------------------------------------
-
- The RoleComparer class provides an Implementation of IComparer for
- RoleInfo objects
-
-
- [cnurse] 05/24/2005 Split into separate file and documented
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- The FilterFlag enum determines which filters are applied by the InputFilter
- function. The Flags attribute allows the user to include multiple
- enumerated values in a single variable by OR'ing the individual values
- together.
-
-
- [Joe Brinkman] 8/15/2003 Created Bug #000120, #000121
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This function uses Regex search strings to remove HTML tags which are
- targeted in Cross-site scripting (XSS) attacks. This function will evolve
- to provide more robust checking as additional holes are found.
-
- This is the string to be filtered
- Filtered UserInput
-
- This is a private function that is used internally by the FormatDisableScripting function
-
-
- [cathal] 3/06/2007 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This function uses Regex search strings to remove HTML tags which are
- targeted in Cross-site scripting (XSS) attacks. This function will evolve
- to provide more robust checking as additional holes are found.
-
- This is the string to be filtered
- Filtered UserInput
-
- This is a private function that is used internally by the InputFilter function
-
-
- [Joe Brinkman] 8/15/2003 Created Bug #000120
- [cathal] 3/06/2007 Added check for encoded content
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This filter removes angle brackets i.e.
-
- This is the string to be filtered
- Filtered UserInput
-
- This is a private function that is used internally by the InputFilter function
-
-
- [Cathal] 6/1/2006 Created to fufill client request
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This filter removes CrLf characters and inserts br
-
- This is the string to be filtered
- Filtered UserInput
-
- This is a private function that is used internally by the InputFilter function
-
-
- [Joe Brinkman] 8/15/2003 Created Bug #000120
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This function verifies raw SQL statements to prevent SQL injection attacks
- and replaces a similar function (PreventSQLInjection) from the Common.Globals.vb module
-
- This is the string to be filtered
- Filtered UserInput
-
- This is a private function that is used internally by the InputFilter function
-
-
- [Joe Brinkman] 8/15/2003 Created Bug #000121
- [Tom Lucas] 3/8/2004 Fixed Bug #000114 (Aardvark)
- 8/5/2009 added additional strings and performance tweak
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This function determines if the Input string contains any markup.
-
- This is the string to be checked
- True if string contains Markup tag(s)
-
- This is a private function that is used internally by the InputFilter function
-
-
- [Joe Brinkman] 8/15/2003 Created Bug #000120
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This function converts a byte array to a hex string
-
- An array of bytes
- A string representing the hex converted value
-
- This is a private function that is used internally by the CreateKey function
-
-
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This function creates a random key
-
- This is the number of bytes for the key
- A random string
-
- This is a public function used for generating SHA1 keys
-
-
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- This function applies security filtering to the UserInput string.
-
- This is the string to be filtered
- Flags which designate the filters to be applied
- Filtered UserInput
-
- [Joe Brinkman] 8/15/2003 Created Bug #000120, #000121
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ClearPermissionCache clears the Tab Permission Cache
-
- The ID of the Tab
-
- [cnurse] 01/15/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteTabPermissionsByUser deletes a user's Tab Permissions in the Database
-
- The user
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetTabPermissions gets a TabPermissionCollection
-
- The ID of the tab
- The ID of the portal
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- HasTabPermission checks whether the current user has a specific Tab Permission
-
- If you pass in a comma delimited list of permissions (eg "ADD,DELETE", this will return
- true if the user has any one of the permissions.
- The Permission to check
-
- [cnurse] 01/15/2008 Documented
- [cnurse] 04/22/2009 Added multi-permisison support
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- HasTabPermission checks whether the current user has a specific Tab Permission
-
- If you pass in a comma delimited list of permissions (eg "ADD,DELETE", this will return
- true if the user has any one of the permissions.
- The Permissions for the Tab
- The Permission(s) to check
-
- [cnurse] 01/15/2008 Documented
- [cnurse] 04/22/2009 Added multi-permisison support
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveTabPermissions saves a Tab's permissions
-
- The Tab to update
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : TabPermissionController
- -----------------------------------------------------------------------------
-
- TabPermissionController provides the Business Layer for Tab Permissions
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : TabPermissionCollection
- -----------------------------------------------------------------------------
-
- TabPermissionCollection provides the a custom collection for TabPermissionInfo
- objects
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new TabPermissionInfo
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new TabPermissionInfo
-
- A PermissionInfo object
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Tab Permission ID
-
- An Integer
-
- [cnurse] 01/15/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Tab ID
-
- An Integer
-
- [cnurse] 01/15/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a TabPermissionInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : TabPermissionInfo
- -----------------------------------------------------------------------------
-
- TabPermissionInfo provides the Entity Layer for Tab Permissions
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Mdoule Definition ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Permission Code
-
- A String
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Permission ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Permission Key
-
- A String
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Permission Name
-
- A String
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillInternal fills a PermissionInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : PermissionInfo
- -----------------------------------------------------------------------------
-
- PermissionInfo provides the Entity Layer for Permissions
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ClearPermissionCache clears the Module Permission Cache
-
- The ID of the Module
-
- [cnurse] 01/15/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteModulePermissionsByUser deletes a user's Module Permission in the Database
-
- The user
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModulePermissions gets a ModulePermissionCollection
-
- The ID of the module
- The ID of the tab
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- HasModulePermission checks whether the current user has a specific Module Permission
-
- If you pass in a comma delimited list of permissions (eg "ADD,DELETE", this will return
- true if the user has any one of the permissions.
- The Permissions for the Module
- The Permission to check
-
- [cnurse] 01/15/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Determines if user has the necessary permissions to access an item with the
- designated AccessLevel.
-
- The SecurityAccessLevel required to access a portal module or module action.
- If Security Access is Edit the permissionKey is the actual "edit" permisison required.
- The ModuleInfo object for the associated module.
- A boolean value indicating if the user has the necessary permissions
- Every module control and module action has an associated permission level. This
- function determines whether the user represented by UserName has sufficient permissions, as
- determined by the PortalSettings and ModuleSettings, to access a resource with the
- designated AccessLevel.
-
- [cnurse] 02/27/2007 New overload
- [cnurse] 02/27/2007 Moved from PortalSecurity
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveModulePermissions updates a Module's permissions
-
- The Module to update
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : ModulePermissionController
- -----------------------------------------------------------------------------
-
- ModulePermissionController provides the Business Layer for Module Permissions
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : ModulePermissionCollection
- -----------------------------------------------------------------------------
-
- ModulePermissionCollection provides the a custom collection for ModulePermissionInfo
- objects
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new ModulePermissionInfo
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new ModulePermissionInfo
-
- A PermissionInfo object
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Module Permission ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Module ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Compares if two ModulePermissionInfo objects are equivalent/equal
-
- a ModulePermissionObject
- true if the permissions being passed represents the same permission
- in the current object
-
-
- This function is needed to prevent adding duplicates to the ModulePermissionCollection.
- ModulePermissionCollection.Contains will use this method to check if a given permission
- is already included in the collection.
-
-
- [Vicenç] 09/01/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a ModulePermissionInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : ModulePermissionInfo
- -----------------------------------------------------------------------------
-
- ModulePermissionInfo provides the Entity Layer for Module Permissions
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveFolderPermissions updates a Folder's permissions
-
- The Folder to update
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new FolderPermissionInfo
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new FolderPermissionInfo
-
- A PermissionInfo object
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a FolderPermissionInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 05/23/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 05/23/2008 Created
-
- -----------------------------------------------------------------------------
-
-
-
- Initializes a new instance of the SearchResultsInfoCollection class.
-
-
-
- Initializes a new instance of the SearchResultsInfoCollection class containing the elements of the specified source collection.
-
- A SearchResultsInfoCollection with which to initialize the collection.
-
-
- Initializes a new instance of the SearchResultsInfoCollection class containing the specified array of SearchResultsInfo objects.
-
- An array of SearchResultsInfo objects with which to initialize the collection.
-
-
- Initializes a new instance of the SearchResultsInfoCollection class containing the specified array of SearchResultsInfo objects.
-
- An array of SearchResultsInfo objects with which to initialize the collection.
-
-
- Gets the SearchResultsInfoCollection at the specified index in the collection.
-
- In VB.Net, this property is the indexer for the SearchResultsInfoCollection class.
-
-
-
-
- Add an element of the specified SearchResultsInfo to the end of the collection.
-
- An object of type SearchResultsInfo to add to the collection.
-
-
- Gets the index in the collection of the specified SearchResultsInfoCollection, if it exists in the collection.
-
- The SearchResultsInfoCollection to locate in the collection.
- The index in the collection of the specified object, if found; otherwise, -1.
-
-
- Add an element of the specified SearchResultsInfo to the collection at the designated index.
-
- An Integer to indicate the location to add the object to the collection.
- An object of type SearchResultsInfo to add to the collection.
-
-
- Remove the specified object of type SearchResultsInfo from the collection.
-
- An object of type SearchResultsInfo to remove to the collection.
-
-
- Gets a value indicating whether the collection contains the specified SearchResultsInfoCollection.
-
- The SearchResultsInfoCollection to search for in the collection.
- true if the collection contains the specified object; otherwise, false.
-
-
- Copies the elements of the specified SearchResultsInfo array to the end of the collection.
-
- An array of type SearchResultsInfo containing the objects to add to the collection.
-
-
- Copies the elements of the specified arraylist to the end of the collection.
-
- An arraylist of type SearchResultsInfo containing the objects to add to the collection.
-
-
- Adds the contents of another SearchResultsInfoCollection to the end of the collection.
-
- A SearchResultsInfoCollection containing the objects to add to the collection.
-
-
- Copies the collection objects to a one-dimensional Array instance beginning at the specified index.
-
- The one-dimensional Array that is the destination of the values copied from the collection.
- The index of the array at which to begin inserting.
-
-
- Creates a one-dimensional Array instance containing the collection items.
-
- Array of type SearchResultsInfo
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Services.Search
- Project: DotNetNuke
- Class: SearchResultsInfoCollection
- -----------------------------------------------------------------------------
-
- Represents a collection of SearchResultsInfo objects.
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Services.Search
- Project: DotNetNuke
- Class: SearchResultsInfo
- -----------------------------------------------------------------------------
-
- The SearchResultsInfo represents a Search Result Item
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
-
- Initializes a new instance of the SearchItemInfoCollection class.
-
-
-
- Initializes a new instance of the SearchItemInfoCollection class containing the elements of the specified source collection.
-
- A SearchItemInfoCollection with which to initialize the collection.
-
-
- Initializes a new instance of the SearchItemInfoCollection class containing the specified array of SearchItemInfo objects.
-
- An array of SearchItemInfo objects with which to initialize the collection.
-
-
- Initializes a new instance of the SearchItemInfoCollectionSearchItemInfoCollection class containing the specified array of SearchItemInfo objects.
-
- An arraylist of SearchItemInfo objects with which to initialize the collection.
-
-
- Gets the SearchItemInfoCollection at the specified index in the collection.
-
- In VB.Net, this property is the indexer for the SearchItemInfoCollection class.
-
-
-
-
- Add an element of the specified SearchItemInfo to the end of the collection.
-
- An object of type SearchItemInfo to add to the collection.
-
-
- Gets the index in the collection of the specified SearchItemInfoCollection, if it exists in the collection.
-
- The SearchItemInfoCollection to locate in the collection.
- The index in the collection of the specified object, if found; otherwise, -1.
-
-
- Add an element of the specified SearchItemInfo to the collection at the designated index.
-
- An Integer to indicate the location to add the object to the collection.
- An object of type SearchItemInfo to add to the collection.
-
-
- Remove the specified object of type SearchItemInfo from the collection.
-
- An object of type SearchItemInfo to remove to the collection.
-
-
- Gets a value indicating whether the collection contains the specified SearchItemInfoCollection.
-
- The SearchItemInfoCollection to search for in the collection.
- true if the collection contains the specified object; otherwise, false.
-
-
- Copies the elements of the specified SearchItemInfo array to the end of the collection.
-
- An array of type SearchItemInfo containing the objects to add to the collection.
-
-
- Copies the elements of the specified arraylist to the end of the collection.
-
- An arraylist of type SearchItemInfo containing the objects to add to the collection.
-
-
- Adds the contents of another SearchItemInfoCollection to the end of the collection.
-
- A SearchItemInfoCollection containing the objects to add to the collection.
-
-
- Copies the collection objects to a one-dimensional Array instance beginning at the specified index.
-
- The one-dimensional Array that is the destination of the values copied from the collection.
- The index of the array at which to begin inserting.
-
-
- Creates a one-dimensional Array instance containing the collection items.
-
- Array of type SearchItemInfo
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Services.Search
- Project: DotNetNuke
- Class: SearchItemInfoCollection
- -----------------------------------------------------------------------------
-
- Represents a collection of SearchItemInfo objects.
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Services.Search
- Project: DotNetNuke
- Class: SearchItemInfo
- -----------------------------------------------------------------------------
-
- The SearchItemInfo represents a Search Item
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DoWork runs the scheduled item
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Services.Search
- Project: DotNetNuke
- Class: SearchEngineScheduler
- -----------------------------------------------------------------------------
-
- The SearchEngineScheduler implements a SchedulerClient for the Indexing of
- portal content.
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- IndexContent indexes all Portal content
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- IndexContent indexes the Portal's content
-
-
-
- The Id of the Portal
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetContent gets all the content and passes it to the Indexer
-
-
-
- The Index Provider that will index the content of the portal
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetContent gets the Portal's content and passes it to the Indexer
-
-
-
- The Id of the Portal
- The Index Provider that will index the content of the portal
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Services.Search
- Project: DotNetNuke
- Class: SearchEngine
- -----------------------------------------------------------------------------
-
- The SearchEngine manages the Indexing of the Portal content
-
-
-
-
- [cnurse] 11/15/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Common.Utilities
- Class: DataCache
- -----------------------------------------------------------------------------
-
- The DataCache class is a facade class for the CachingProvider Instance's
-
-
- [cnurse] 12/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PortalTemplateValidator Class is used to validate the Portal Template
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a PortalInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetPortalCallback gets the Portal from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetPortalDictioanryCallback gets the Portal Lookup Dictionary from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 07/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetPortalSettingsDictionaryCallback gets a Dictionary of Portal Settings
- from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetPortalsByName gets all the portals whose name matches a provided filter expression
-
-
-
- The email address to use to find a match.
- The page of records to return.
- The size of the page
- The total no of records that satisfy the criteria.
- An ArrayList of PortalInfo objects.
-
- [cnurse] 11/17/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates a new portal based on the portal template provided.
-
- Name of the portal to be created
- PortalId of the new portal if there are no errors, -1 otherwise.
-
-
-
- [VMasanas] 03/09/2004 Modified to support new template format.
- Portal template file should be processed before admin.template
- [cnurse] 01/11/2005 Template parsing moved to CreatePortal
- [cnurse] 05/10/2006 Removed unneccessary use of Administrator properties
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processes all Files from the template
-
- Template file node for the Files
- PortalId of the new portal
-
- [cnurse] 11/09/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processes all Folders from the template
-
- Template file node for the Folders
- PortalId of the new portal
-
- [cnurse] 11/09/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Parses folder permissions
-
- Node for folder permissions
- PortalId of new portal
- The folder being processed
-
-
-
- [cnurse] 11/09/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processes the settings node
-
- Template file node for the settings
- PortalId of the new portal
-
-
-
- [VMasanas] 27/08/2004 Created
- [VMasanas] 15/10/2004 Modified for new skin structure
- [cnurse] 11/21/2004 Modified to use GetNodeValueDate for ExpiryDate
- [VMasanas] 02/21/2005 Modified to not overwrite ExpiryDate if not present
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processes all Profile Definitions from the template
-
- Template file node for the Profile Definitions
- PortalId of the new portal
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processes all tabs from the template
-
- Template file node for the tabs
- PortalId of the new portal
- True when processing admin template, false when processing portal template
- Flag to determine whether Module content is merged.
- Flag to determine is the template is applied to an existing portal or a new one.
-
- When a special tab is found (HomeTab, UserTab, LoginTab, AdminTab) portal information will be updated.
-
-
- [VMasanas] 26/08/2004 Removed code to allow multiple tabs with same name.
- [VMasanas] 15/10/2004 Modified for new skin structure
- [cnurse] 15/10/2004 Modified to allow for merging template
- with existing pages
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processes a single tab from the template
-
- Template file node for the tabs
- PortalId of the new portal
- True when processing admin template, false when processing portal template
- Flag to determine whether Module content is merged.
- Used to control if modules are true modules or instances
- Supporting object to build the tab hierarchy
- Flag to determine is the template is applied to an existing portal or a new one.
-
- When a special tab is found (HomeTab, UserTab, LoginTab, AdminTab) portal information will be updated.
-
-
- [VMasanas] 26/08/2004 Removed code to allow multiple tabs with same name.
- [VMasanas] 15/10/2004 Modified for new skin structure
- [cnurse] 15/10/2004 Modified to allow for merging template
- with existing pages
- [cnurse] 11/21/2204 modified to use GetNodeValueDate for Start and End Dates
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates a new portal alias
-
- Id of the portal
- Portal Alias to be created
-
-
-
- [cnurse] 01/11/2005 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates a new portal.
-
- Name of the portal to be created
- Portal Administrator's first name
- Portal Administrator's last name
- Portal Administrator's username
- Portal Administrator's password
- Portal Administrator's email
- Description for the new portal
- KeyWords for the new portal
- Path where the templates are stored
- Template file
- Portal Alias String
- The Path to the root of the Application
- The Path to the Child Portal Folder
- True if this is a child portal
- PortalId of the new portal if there are no errors, -1 otherwise.
-
- After the selected portal template is parsed the admin template ("admin.template") will be
- also processed. The admin template should only contain the "Admin" menu since it's the same
- on all portals. The selected portal template can contain a node to specify portal
- properties and a node to define the roles that will be created on the portal by default.
-
-
- [cnurse] 11/08/2004 created (most of this code was moved from SignUp.ascx.vb)
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates a new portal.
-
- Name of the portal to be created
- Portal Administrator
- Description for the new portal
- KeyWords for the new portal
- Path where the templates are stored
- Template file
- Portal Alias String
- The Path to the root of the Application
- The Path to the Child Portal Folder
- True if this is a child portal
- PortalId of the new portal if there are no errors, -1 otherwise.
-
- After the selected portal template is parsed the admin template ("admin.template") will be
- also processed. The admin template should only contain the "Admin" menu since it's the same
- on all portals. The selected portal template can contain a node to specify portal
- properties and a node to define the roles that will be created on the portal by default.
-
-
- [cnurse] 05/12/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Deletes a portal permanently
-
- PortalId of the portal to be deleted
-
-
-
- [VMasanas] 03/09/2004 Created
- [VMasanas] 26/10/2004 Remove dependent data (skins, modules)
- [cnurse] 24/11/2006 Removal of Modules moved to sproc
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets information of a portal
-
- Id of the portal
- PortalInfo object with portal definition
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets information from all portals
-
- ArrayList of PortalInfo objects
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the space used at the host level
-
- Space used in bytes
-
-
-
- [VMasanas] 19/04/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the space used by a portal in bytes
-
- Id of the portal
- Space used in bytes
-
-
-
- [VMasanas] 07/04/2006 Created
- [VMasanas] 11/05/2006 Use file size stored on the db. This is necessary
- to take into account the new secure file storage options
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Verifies if there's enough space to upload a new file on the given portal
-
- Id of the portal
- Size of the file being uploaded
- True if there's enough space available to upload the file
-
-
-
- [VMasanas] 19/04/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processess a template file for the new portal. This method will be called twice: for the portal template and for the admin template
-
- PortalId of the new portal
- Path for the folder where templates are stored
- Template file to process
- UserId for the portal administrator. This is used to assign roles to this user
- Flag to determine whether Module content is merged.
- Flag to determine is the template is applied to an existing portal or a new one.
-
- The roles and settings nodes will only be processed on the portal template file.
-
-
- [VMasanas] 27/08/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Processes the resource file for the template file selected
-
- New portal's folder
- Selected template file
-
- The resource file is a zip file with the same name as the selected template file and with
- an extension of .resources (to unable this file being downloaded).
- For example: for template file "portal.template" a resource file "portal.template.resources" can be defined.
-
-
- [VMasanas] 10/09/2004 Created
- [cnurse] 11/08/2004 Moved from SignUp to PortalController
- [cnurse] 03/04/2005 made Public
- [cnurse] 05/20/2005 moved most of processing to new method in FileSystemUtils
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates basic portal information
-
-
-
-
-
- [cnurse] 10/13/2004 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates basic portal information
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetPortalAliasLookupCallBack gets a Dictionary of Host Settings from
- the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 07/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ID of the Associated Desktop Module
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Associated Desktop Module
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ID of the Associated Module Definition
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Associated Module Definition
-
- A ModuleDefinitionInfo
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a ModuleInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : ModuleInfo
- -----------------------------------------------------------------------------
-
- ModuleInfo provides the Entity Layer for Modules
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Module Definition ID
-
- An Integer
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Default Cache Time
-
- An Integer
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the associated Desktop Module ID
-
- An Integer
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Friendly Name
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Dictionary of ModuleControls that are part of this definition
-
- A Dictionary(Of String, ModuleControlInfo)
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Dictionary of Permissions that are part of this definition
-
- A String
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a ModuleDefinitionInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/11/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/11/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an XmlSchema for the ModuleDefinitionInfo
-
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads the ModuleControls from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a ModuleDefinitionInfo from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes a ModuleDefinitionInfo to an XmlWriter
-
- The XmlWriter to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules.Definitions
- Class : ModuleDefinitionInfo
- -----------------------------------------------------------------------------
-
- ModuleDefinitionInfo provides the Entity Layer for Module Definitions
-
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleDefinitionsCallBack gets a Dictionary of Module Definitions from
- the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/13/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleDefinitionByID gets a Module Definition by its ID
-
- The ID of the Module Definition
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleDefinitionByFriendlyName gets a Module Definition by its Friendly
- Name
-
- The friendly name
-
- [cnurse] 10/30/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleDefinitionByFriendlyName gets a Module Definition by its Friendly
- Name (and DesktopModuleID)
-
- The friendly name
- The ID of the Dekstop Module
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleDefinitions gets a Dictionary of Module Definitions.
-
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleDefinitionsByDesktopModuleID gets a Dictionary of Module Definitions
- with a particular DesktopModuleID, keyed by the FriendlyName.
-
- The ID of the Desktop Module
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveModuleDefinition saves the Module Definition to the database
-
- The Module Definition to save
- A flag that determines whether the child objects are also saved
- A flag that determines whether to clear the host cache
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteModuleDefinition deletes a Module Definition By ID
-
- The Module Definition to delete
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteModuleDefinition deletes a Module Definition By ID
-
- The ID of the Module Definition to delete
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules.Definitions
- Class : ModuleDefinitionController
- -----------------------------------------------------------------------------
-
- ModuleDefinitionController provides the Business Layer for Module Definitions
-
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds module content to the node module
-
- Node where to add the content
- Module
-
-
-
- [vmasanas] 25/10/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetTabModulesCallBack gets a Dictionary of Modules by
- Tab from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
-
- SerializeModule
-
- The Xml Document to use for the Module
- The ModuleInfo object to serialize
- A flak that determines whether the content of the module is serialised.
-
-
- add a module to a page
-
- moduleInfo for the module to create
- ID of the created module
-
- [sleupold] 2007-09-24 documented
-
-
- -----------------------------------------------------------------------------
-
- CopyModule copies a Module from one Tab to another optionally including all the
- TabModule settings
-
-
-
- The Id of the module to copy
- The Id of the source tab
- The Id of the destination tab
- The name of the Pane on the destination tab where the module will end up
- A flag to indicate whether the settings are copied to the new Tab
-
- [cnurse] 10/21/2004 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CopyModule copies a Module from one Tab to a collection of Tabs optionally
- including the TabModule settings
-
-
-
- The Id of the module to copy
- The Id of the source tab
- An ArrayList of TabItem objects
- A flag to indicate whether the settings are copied to the new Tab
-
- [cnurse] 2004-10-22 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CopyTabModuleSettings copies the TabModuleSettings from one instance to another
-
-
-
- The module to copy from
- The module to copy to
-
- [cnurse] 2005-01-11 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteAllModules deletes all instances of a Module (from a collection). This overload
- soft deletes the instances
-
- The Id of the module to copy
- The Id of the current tab
- An ArrayList of TabItem objects
-
- [cnurse] 2009-03-24 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteAllModules deletes all instances of a Module (from a collection), optionally excluding the
- current instance, and optionally including deleting the Module itself.
-
-
- Note - the base module is not removed unless both the flags are set, indicating
- to delete all instances AND to delete the Base Module
-
- The Id of the module to copy
- The Id of the current tab
- A flag that determines whether the instance should be soft-deleted
- An ArrayList of TabItem objects
- A flag to indicate whether to delete from the current tab
- as identified ny tabId
- A flag to indicate whether to delete the Module itself
-
- [cnurse] 2004-10-22 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Delete a module instance permanently from the database
-
- ID of the module instance
-
- [sleupold] 1007-09-24 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Delete a module reference permanently from the database.
- if there are no other references, the module instance is deleted as well
-
- ID of the page
- ID of the module instance
- A flag that determines whether the instance should be soft-deleted
-
- [sleupold] 1007-09-24 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- get info of all modules in any portal of the installation
-
- moduleInfo of all modules
- created for upgrade purposes
-
- [sleupold] 2007-09-24 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- get a Module object
-
- ID of the module
- a ModuleInfo object - note that this method will always hit the database as no TabID cachekey is provided
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- get a Module object
-
- ID of the module
- ID of the page
- a ModuleInfo object
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- get a Module object
-
- ID of the module
- ID of the page
- flag, if data shall not be taken from cache
- ArrayList of ModuleInfo objects
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- get all Module objects of a portal
-
- ID of the portal
- ArrayList of ModuleInfo objects
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- get Module objects of a portal, either only those, to be placed on all tabs or not
-
- ID of the portal
- specify, whether to return modules to be shown on all tabs or those to be shown on specified tabs
- ArrayList of TabModuleInfo objects
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Get ModuleInfo object of first module instance with a given friendly name of the module definition
-
- ID of the portal, where to look for the module
- friendly name of module definition
- ModuleInfo of first module instance
- preferably used for admin and host modules
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- For a portal get a list of all active module and tabmodule references that support iSearchable
-
- ID of the portal to be searched
- Arraylist of ModuleInfo for modules supporting search.
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Get all Module references on a tab
-
-
- Dictionary of ModuleID and ModuleInfo
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- MoveModule moes a Module from one Tab to another including all the
- TabModule settings
-
- The Id of the module to move
- The Id of the source tab
- The Id of the destination tab
- The name of the Pane on the destination tab where the module will end up
-
- [cnurse] 10/21/2004 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Update module settings and permissions in database from ModuleInfo
-
- ModuleInfo of the module to update
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- set/change the module position within a pane on a page
-
- ID of the page
- ID of the module on the page
- position within the controls list on page, -1 if to be added at the end
- name of the pane, the module is placed in on the page
-
- [sleupold] 2007-09-24 commented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- set/change all module's positions within a page
-
- ID of the page
-
- [sleupold] 2007-09-24 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Get a list of all TabModule references of a module instance
-
- ID of the Module
- ArrayList of ModuleInfo
-
- [sleupold] 2007-09-24 documented
-
- -----------------------------------------------------------------------------
-
-
-
- read all settings for a module from ModuleSettings table
-
- ID of the module
- (cached) hashtable containing all settings
- TabModuleSettings are not included
-
- [sleupold] 2007-09-24 commented
-
-
-
- Adds or updates a module's setting value
-
- ID of the module, the setting belongs to
- name of the setting property
- value of the setting (String).
- empty SettingValue will remove the setting, if not preserveIfEmpty is true
-
- [sleupold] 2007-09-24 added removal for empty settings
-
-
-
- Delete a Setting of a module instance
-
- ID of the affected module
- Name of the setting to be deleted
-
- [sleupold] 2007-09-24 documented
-
-
-
- Delete all Settings of a module instance
-
- ID of the affected module
-
- [sleupold] 2007-09-24 documented
-
-
-
- read all settings for a module on a page from TabModuleSettings Table
-
- ID of the tabModule
- (cached) hashtable containing all settings
- ModuleSettings are not included
-
- [sleupold] 2007-09-24 documented
-
-
-
- Adds or updates a module's setting value
-
- ID of the tabmodule, the setting belongs to
- name of the setting property
- value of the setting (String).
- empty SettingValue will relove the setting
-
- [sleupold] 2007-09-24 added removal for empty settings
-
-
-
- Delete a specific setting of a tabmodule reference
-
- ID of the affected tabmodule
- Name of the setting to remove
-
- [sleupold] 2007-09-24 documented
-
-
-
- Delete all settings of a tabmodule reference
-
- ID of the affected tabmodule
-
- [sleupold] 2007-09-24 documented
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : ModuleController
- -----------------------------------------------------------------------------
-
- ModuleController provides the Business Layer for Modules
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Module Control ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Module Definition ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Control Title
-
- A String
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Control Type
-
- A SecurityAccessLevel
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Icon Source
-
- A String
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Help URL
-
- A String
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the View Order
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a ModuleControlInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an XmlSchema for the ModuleControlInfo
-
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a ModuleControlInfo from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes a ModuleControlInfo to an XmlWriter
-
- The XmlWriter to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : ModuleControlInfo
- -----------------------------------------------------------------------------
-
- ModuleControlInfo provides the Entity Layer for Module Controls
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleControls gets a Dictionary of Module Controls from
- the Cache.
-
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleControlsCallBack gets a Dictionary of Module Controls from
- the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddModuleControl adds a new Module Control to the database
-
- The Module Control to save
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteModuleControl deletes a Module Control in the database
-
- The ID of the Module Control to delete
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleControl gets a single Module Control from the database
-
- The ID of the Module Control to fetch
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleControl gets a Dictionary of Module Controls by Module Definition
-
- The ID of the Module Definition
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModuleControlByControlKey gets a single Module Control from the database
-
- The key for the control
- The ID of the Module Definition
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveModuleControl updates a Module Control in the database
-
- The Module Control to save
- A flag that determines whether to clear the host cache
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateModuleControl updates a Module Control in the database
-
- The Module Control to save
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : ModuleControlController
- -----------------------------------------------------------------------------
-
- ModuleControlController provides the Business Layer for Module Controls
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
-
-
- [cniknet] 10/15/2004 Replaced public members with properties and removed
- brackets from property names
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
-
-
-
-
-
- [jbrinkman] 12/27/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
-
-
-
-
- [jbrinkman] 12/27/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
-
-
-
-
- [jbrinkman] 12/27/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
- Project : DotNetNuke
- Class : ModuleActionEventListener
-
------------------------------------------------------------------------------
-
-
-
-
- [jbrinkman] 12/27/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Initializes a new, empty instance of the class.
-
- The default constructor creates an empty collection of
- objects.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Initializes a new instance of the
- class containing the elements of the specified source collection.
-
- A with which to initialize the collection.
- This overloaded constructor copies the s
- from the indicated collection.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Initializes a new instance of the
- class containing the specified array of objects.
-
- An array of objects
- with which to initialize the collection.
- This overloaded constructor copies the s
- from the indicated array.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets or sets the at the
- specified index in the collection.
-
- In VB.Net, this property is the indexer for the class.
-
-
- The index of the collection to access.
- A at each valid index.
- This method is an indexer that can be used to access the collection.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Add an element of the specified to the end of the collection.
-
- An object of type to add to the collection.
- The index of the newly added
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Add an element of the specified to the end of the collection.
-
- This is the identifier to use for this action.
- This is the title that will be displayed for this action
- The command name passed to the client when this action is
- clicked.
- The command argument passed to the client when this action is
- clicked.
- The URL of the Icon to place next to this action
- The destination URL to redirect the client browser when this
- action is clicked.
- Determines whether client will receive an event
- notification
- The security access level required for access to this action
- Whether this action will be displayed
- The index of the newly added
- This method creates a new with the specified
- values, adds it to the collection and returns the index of the newly created ModuleAction.
-
- [Joe] 10/18/2003 Created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Add an element of the specified to the end of the collection.
-
- This is the identifier to use for this action.
- This is the title that will be displayed for this action
- The command name passed to the client when this action is
- clicked.
- The command argument passed to the client when this action is
- clicked.
- The URL of the Icon to place next to this action
- The destination URL to redirect the client browser when this
- action is clicked.
- Client side script to be run when the this action is
- clicked.
- Determines whether client will receive an event
- notification
- The security access level required for access to this action
- Whether this action will be displayed
- The index of the newly added
- This method creates a new with the specified
- values, adds it to the collection and returns the index of the newly created ModuleAction.
- '''
- [jbrinkman] 5/22/2004 Created
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Copies the elements of the specified
- array to the end of the collection.
-
- An array of type
- containing the objects to add to the collection.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Adds the contents of another
- to the end of the collection.
-
- A containing
- the objects to add to the collection.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets a value indicating whether the collection contains the specified .
-
- The to search for in the collection.
- true if the collection contains the specified object; otherwise, false.
-
-
- ' Tests for the presence of a ModuleAction in the
- ' collection, and retrieves its index if it is found.
- Dim testModuleAction = New ModuleAction(5, "Edit Action", "Edit")
- Dim itemIndex As Integer = -1
- If collection.Contains(testModuleAction) Then
- itemIndex = collection.IndexOf(testModuleAction)
- End If
-
-
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets the index in the collection of the specified ,
- if it exists in the collection.
-
- The to locate in the collection.
- The index in the collection of the specified object, if found; otherwise, -1.
- This example tests for the presense of a ModuleAction in the
- collection, and retrieves its index if it is found.
-
- Dim testModuleAction = New ModuleAction(5, "Edit Action", "Edit")
- Dim itemIndex As Integer = -1
- If collection.Contains(testModuleAction) Then
- itemIndex = collection.IndexOf(testModuleAction)
- End If
-
-
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Add an element of the specified to the
- collection at the designated index.
-
- An Integer to indicate the location to add the object to the collection.
- An object of type to add to the collection.
-
-
- ' Inserts a ModuleAction at index 0 of the collection.
- collection.Insert(0, New ModuleAction(5, "Edit Action", "Edit"))
-
-
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Remove the specified object of type from the collection.
-
- An object of type to remove from the collection.
-
-
- ' Removes the specified ModuleAction from the collection.
- Dim testModuleAction = New ModuleAction(5, "Edit Action", "Edit")
- collection.Remove(testModuleAction)
-
-
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
- Project : DotNetNuke
- Class : ModuleActionCollection
------------------------------------------------------------------------------
-
- Represents a collection of objects.
-
- The ModuleActionCollection is a custom collection of ModuleActions.
- Each ModuleAction in the collection has it's own
- collection which provides the ability to create a heirarchy of ModuleActions.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Initializes a new instance of the class
- using the specified parameters
-
- This is the identifier to use for this action.
- This is the title that will be displayed for this action
- The command name passed to the client when this action is
- clicked.
- The command argument passed to the client when this action is
- clicked.
- The URL of the Icon to place next to this action
- The destination URL to redirect the client browser when this
- action is clicked.
- Determines whether client will receive an event
- notification
- The security access level required for access to this action
- Whether this action will be displayed
- The moduleaction constructor is used to set the various properties of
- the class at the time the instance is created.
-
-
- [Joe] 10/26/2003 Created
- [Nik Kalyani] 10/15/2004 Created multiple signatures to eliminate Optional parameters
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Determines whether the action node contains any child actions.
-
- True if child actions exist, false if child actions do not exist.
- Each action may contain one or more child actions in the
- property. When displayed via
- the control, these subactions are
- shown as sub-menus.
-
- [Joe] 10/26/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- The Actions property allows the user to create a heirarchy of actions, with
- each action having sub-actions.
-
- Returns a collection of ModuleActions.
- Each action may contain one or more child actions. When displayed via
- the control, these subactions are
- shown as sub-menus. If other Action controls are implemented, then
- sub-actions may or may not be supported for that control type.
-
- [Joe] 10/26/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- A Module Action ID is a identifier that can be used in a Module Action Collection
- to find a specific Action.
-
- The integer ID of the current .
- When building a heirarchy of ModuleActions,
- the ID is used to link the child and parent actions.
-
- [Joe] 10/18/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets or sets whether the current action should be displayed.
-
- A boolean value that determines if the current action should be displayed
- If Visible is false, then the action is always hidden. If Visible
- is true then the action may be visible depending on the security access rights
- specified by the property. By
- utilizing a custom method in your module, you can encapsulate specific business
- rules to determine if the Action should be visible.
-
- [Joe] 10/26/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets or sets the value indicating the that is required
- to access this .
-
- The value indicating the that is required
- to access this
- The security access level determines the roles required by the current user in
- order to access this module action.
-
- [jbrinkman] 12/27/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- A Module Action CommandName represents a string used by the ModuleTitle to notify
- the parent module that a given Module Action was selected in the Module Menu.
-
- The name of the command to perform.
-
- Use the CommandName property to determine the command to perform. The CommandName
- property can contain any string set by the programmer. The programmer can then
- identify the command name in code and perform the appropriate tasks.
-
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- A Module Action CommandArgument provides additional information and
- complements the CommandName.
-
- A string that contains the argument for the command.
-
- The CommandArgument can contain any string set by the programmer. The
- CommandArgument property complements the
- property by allowing you to provide any additional information for the command.
- For example, you can set the CommandName property to "Sort" and set the
- CommandArgument property to "Ascending" to specify a command to sort in ascending
- order.
-
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets or sets the string that is displayed in the Module Menu
- that represents a given menu action.
-
- The string value that is displayed to represent the module action.
- The title property is displayed by the Actions control for each module
- action.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets or sets the URL for the icon file that is displayed for the given
- .
-
- The URL for the icon that is displayed with the module action.
- The URL for the icon is a simple string and is not checked for formatting.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets or sets the URL to which the user is redirected when the
- associated Module Menu Action is selected.
-
- The URL to which the user is redirected when the
- associated Module Menu Action is selected.
- If the URL is present then the Module Action Event is not fired.
- If the URL is empty then the Action Event is fired and is passed the value
- of the associated Command property.
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets javascript which will be run in the clients browser
- when the associated Module menu Action is selected. prior to a postback.
-
- The Javascript which will be run during the menuClick event
- If the ClientScript property is present then it is called prior
- to the postback occuring. If the ClientScript returns false then the postback
- is canceled. If the ClientScript is empty then the Action Event is fired and
- is passed the value of the associated Command property.
-
- [jbrinkman] 5/21/2004 Created
-
- -----------------------------------------------------------------------------
-
-
-
- Gets or sets a value that determines if a local ActionEvent is fired when the
- contains a URL.
-
- A boolean indicating whether to fire the ActionEvent.
- When a MenuAction is clicked, an event is fired within the Actions
- control. If the UseActionEvent is true then the Actions control will forward
- the event to the parent skin which will then attempt to raise the event to
- the appropriate module. If the UseActionEvent is false, and the URL property
- is set, then the Actions control will redirect the response to the URL. In
- all cases, an ActionEvent is raised if the URL is not set.
-
- [jbrinkman] 12/22/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets or sets a value that determines if a new window is opened when the
- DoAction() method is called.
-
- A boolean indicating whether to open a new window.
-
-
- [jbrinkman] 12/22/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
- Project : DotNetNuke
- Class : ModuleAction
------------------------------------------------------------------------------
-
- Each Module Action represents a separate functional action as defined by the
- associated module.
-
- A module action is used to define a specific function for a given module.
- Each module can define one or more actions which the portal will present to the
- user. These actions may be presented as a menu, a dropdown list or even a group
- of linkbuttons.
-
-
- [Joe] 10/9/2003 Created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ID of the Desktop Module
-
- An Integer
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ID of the Package for this Desktop Module
-
- An Integer
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the AppCode Folder Name of the Desktop Module
-
- A String
-
- [cnurse] 02/20/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the BusinessControllerClass of the Desktop Module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a Regular Expression that matches the versions of the core
- that this module is compatible with
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a list of Dependencies for the module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Description of the Desktop Module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Folder Name of the Desktop Module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Friendly Name of the Desktop Module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Module is an Admin Module
-
- A Boolean
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Module is Portable
-
- A Boolean
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Module is a Premium Module
-
- A Boolean
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Module is Searchable
-
- A Boolean
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Module is Upgradable
-
- A Boolean
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Module Definitions for this Desktop Module
-
- A Boolean
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Name of the Desktop Module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a list of Permissions for the module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Supported Features of the Module
-
- An Integer
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Version of the Desktop Module
-
- A String
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Clears a Feature from the Features
-
- The feature to Clear
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Feature from the Features
-
- The feature to Get
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Sets a Feature in the Features
-
- The feature to Set
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates a Feature in the Features
-
- The feature to Set
- A Boolean indicating whether to set or clear the feature
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a DesktopModuleInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/11/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/11/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an XmlSchema for the DesktopModule
-
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a Supported Features from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a Module Definitions from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a DesktopModuleInfo from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes a DesktopModuleInfo to an XmlWriter
-
- The XmlWriter to use
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : DesktopModuleInfo
- -----------------------------------------------------------------------------
-
- DesktopModuleInfo provides the Entity Layer for Desktop Modules
-
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModulesByPortalCallBack gets a Dictionary of Desktop Modules by
- Portal from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/13/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteDesktopModule deletes a Desktop Module
-
- The Name of the Desktop Module to delete
-
- [cnurse] 05/14/2009 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModule gets a Desktop Module by its ID
-
- This method uses the cached Dictionary of DesktopModules. It first checks
- if the DesktopModule is in the cache. If it is not in the cache it then makes a call
- to the Dataprovider.
- The ID of the Desktop Module to get
- The ID of the portal
-
- [cnurse] 01/13/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModuleByPackageID gets a Desktop Module by its Package ID
-
- The ID of the Package
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModuleByModuleName gets a Desktop Module by its Name
-
- This method uses the cached Dictionary of DesktopModules. It first checks
- if the DesktopModule is in the cache. If it is not in the cache it then makes a call
- to the Dataprovider.
- The name of the Desktop Module to get
- The ID of the portal
-
- [cnurse] 01/13/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModules gets a Dictionary of Desktop Modules
-
- The ID of the Portal (Use PortalID = Null.NullInteger (-1) to get
- all the DesktopModules including Modules not allowed for the current portal
-
- [cnurse] 01/13/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveDesktopModule saves the Desktop Module to the database
-
- The Desktop Module to save
- A flag that determines whether the child objects are also saved
- A flag that determines whether to clear the host cache
-
- [cnurse] 01/13/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddDesktopModule adds a new Desktop Module to the database
-
- The Desktop Module to save
-
- [cnurse] 01/11/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteDesktopModule deletes a Desktop Module
-
- The Desktop Module to delete
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteDesktopModule deletes a Desktop Module By ID
-
- The ID of the Desktop Module to delete
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateDesktopModule saves the Desktop Module to the database
-
- The Desktop Module to save
-
- [cnurse] 01/11/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : DesktopModuleController
- -----------------------------------------------------------------------------
-
- DesktopModuleController provides the Busines Layer for Desktop Modules
-
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
-
-
-
-
-
- [Joe] 10/26/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
-
-
-
-
- [Joe] 10/26/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
-
-
-
-
- [jbrinkman] 12/27/2003 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace : DotNetNuke.Entities.Modules.Actions
- Class : ActionEventArgs
------------------------------------------------------------------------------
-
- ActionEventArgs provides a custom EventARgs class for Action Events
-
-
-
- [Joe] 10/26/2003 Created
-
------------------------------------------------------------------------------
-
-
-
- CultureDropDownTypes allows the user to specify which culture name is displayed in the drop down list that is filled
- by using one of the helper methods.
-
-
- -----------------------------------------------------------------------------
-
- The CurrentCulture returns the current Culture being used
- is 'key'.
-
-
-
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The KeyName property returns and caches the name of the key attribute used to lookup resources.
- This can be configured by setting ResourceManagerKey property in the web.config file. The default value for this property
- is 'key'.
-
-
-
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ShowMissingKeys property returns the web.config setting that determines
- whether to render a visual indicator that a key is missing
- is 'key'.
-
-
-
-
- [cnurse] 11/20/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetLocalesCallBack gets a Dictionary of Locales by
- Portal from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetResourceFileName is used to build the resource file name according to the
- language
-
- The language
- The resource file root
- The language specific resource file
-
- [cnurse] 10/06/2004 created
-
- -----------------------------------------------------------------------------
-
-
-
- Provides localization support for DataControlFields used in DetailsView and GridView controls
-
- The field control to localize
- The root name of the Resource File where the localized
- text can be found
-
- The header of the DataControlField is localized.
- It also localizes text for following controls: ButtonField, CheckBoxField, CommandField, HyperLinkField, ImageField
-
-
- -----------------------------------------------------------------------------
-
- Returns the TimeZone file name for a given resource and language
-
- Resource File
- Language
- Localized File Name
-
-
-
- [vmasanas] 04/10/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- TryGetFromResourceFile is used to get the string from a resource file
-
- This method searches a resource file for the key. It first checks the
- user's language, then the fallback language and finally the default language.
-
- The resource key
- The resource file to search
- The user's language
- The fallback language for the user's language
- The portal's default language
- The id of the portal
- The resulting resource value - returned by reference
- True if successful, false if not found
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- TryGetFromResourceFile is used to get the string from a resource file
-
- This method searches a specific language version of the resource file for
- the key. It first checks the Portal version, then the Host version and finally
- the Application version
- The resource key
- The resource file to search
- The id of the portal
- The resulting resource value - returned by reference
- True if successful, false if not found
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- TryGetFromResourceFile is used to get the string from a specific resource file
-
- This method searches a specific resource file for the key.
- The resource key
- The resource file to search
- The id of the portal
- The resulting resource value - returned by reference
- An enumerated CustomizedLocale - Application - 0,
- Host - 1, Portal - 2 - that identifies the file to search
- True if successful, false if not found
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- TryGetStringInternal is used to get the string from a resource file
-
- This method searches a resource file for the key. It first checks the
- user's language, then the fallback language and finally the default language.
-
- The resource key
- The user's language
- The resource file to search
- The portal settings
- The resulting resource value - returned by reference
- True if successful, false if not found
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- One of six overloads
-
- GetString gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The localized Text
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- One of six overloads
-
- GetString gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The current portals Portal Settings
- The localized Text
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- One of six overloads
-
- GetString gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The Local Resource root
- The localized Text
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- One of six overloads
-
- GetString gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The Local Resource root
- The localized Text
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- One of six overloads
-
- GetString gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The Local Resource root
- A specific language to lookup the string
- The localized Text
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- One of six overloads
-
- GetString gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The Local Resource root
- The current portals Portal Settings
- A specific language to lookup the string
- The localized Text
-
- [cnurse] 10/06/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- One of six overloads
-
- GetString gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The Local Resource root
- The current portals Portal Settings
- A specific language to lookup the string
- Disables the show missing keys flag
- The localized Text
-
- [cnurse] 10/06/2004 Documented
- [cnurse] 01/30/2008 Refactored to use Dictionaries and to cahe the portal and host
- customisations and language versions separately
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetStringUrl gets the localized string corresponding to the resourcekey
-
- The resourcekey to find
- The Local Resource root
- The localized Text
-
- This function should be used to retrieve strings to be used on URLs.
- It is the same as GetString(name,ResourceFileRoot method
- but it disables the ShowMissingKey flag, so even it testing scenarios, the correct string
- is returned
-
-
- [vmasanas] 11/21/2006 Added
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage.
-
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- The message body with all tags replaced.
-
- Supported tags:
- - All fields from HostSettings table in the form of: [Host:field]
- - All properties defined in in the form of: [Portal:property]
- - [Portal:URL]: The base URL for the portal
- - All properties defined in in the form of: [User:property]
- - All values stored in the user profile in the form of: [Profile:key]
- - [User:VerificationCode]: User verification code for verified registrations
- - [Date:Current]: Current date
-
-
- [Vicenç] 05/07/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage.
-
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- Reference to the user used to personalize the message.
- The message body with all tags replaced.
-
- Supported tags:
- - All fields from HostSettings table in the form of: [Host:field]
- - All properties defined in in the form of: [Portal:property]
- - [Portal:URL]: The base URL for the portal
- - All properties defined in in the form of: [User:property]
- - All values stored in the user profile in the form of: [Profile:key]
- - [User:VerificationCode]: User verification code for verified registrations
- - [Date:Current]: Current date
-
-
- [Vicenç] 05/07/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ''' Gets a SystemMessage.
-
- A specific language to get the SystemMessage for.
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- Reference to the user used to personalize the message.
- The message body with all tags replaced.
-
- Supported tags:
- - All fields from HostSettings table in the form of: [Host:field]
- - All properties defined in in the form of: [Portal:property]
- - [Portal:URL]: The base URL for the portal
- - All properties defined in in the form of: [User:property]
- - All values stored in the user profile in the form of: [Profile:key]
- - [User:VerificationCode]: User verification code for verified registrations
- - [Date:Current]: Current date
-
-
- [Vicenç] 05/07/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage.
-
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- The root name of the Resource File where the localized
- text can be found
- The message body with all tags replaced.
-
- Supported tags:
- - All fields from HostSettings table in the form of: [Host:field]
- - All properties defined in in the form of: [Portal:property]
- - [Portal:URL]: The base URL for the portal
- - All properties defined in in the form of: [User:property]
- - All values stored in the user profile in the form of: [Profile:key]
- - [User:VerificationCode]: User verification code for verified registrations
- - [Date:Current]: Current date
-
-
- [Vicenç] 05/07/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage.
-
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- Reference to the user used to personalize the message.
- The root name of the Resource File where the localized
- text can be found
- The message body with all tags replaced.
-
- Supported tags:
- - All fields from HostSettings table in the form of: [Host:field]
- - All properties defined in in the form of: [Portal:property]
- - [Portal:URL]: The base URL for the portal
- - All properties defined in in the form of: [User:property]
- - All values stored in the user profile in the form of: [Profile:key]
- - [User:VerificationCode]: User verification code for verified registrations
- - [Date:Current]: Current date
-
-
- [Vicenç] 05/07/2004 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage passing extra custom parameters to personalize.
-
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- The root name of the Resource File where the localized
- text can be found
- An ArrayList with replacements for custom tags.
- The message body with all tags replaced.
-
- Custom tags are of the form [Custom:n], where n is the zero based index which
- will be used to find the replacement value in Custom parameter.
-
-
- [Vicenç] 05/07/2004 Documented
- [cnurse] 10/06/2004 Moved from SystemMessages to Localization
- [DanCaron] 10/27/2004 Simplified Profile replacement, added Membership replacement
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage passing extra custom parameters to personalize.
-
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- Reference to the user used to personalize the message.
- The root name of the Resource File where the localized
- text can be found
- An ArrayList with replacements for custom tags.
- The message body with all tags replaced.
-
- Custom tags are of the form [Custom:n], where n is the zero based index which
- will be used to find the replacement value in Custom parameter.
-
-
- [Vicenç] 05/07/2004 Documented
- [cnurse] 10/06/2004 Moved from SystemMessages to Localization
- [DanCaron] 10/27/2004 Simplified Profile replacement, added Membership replacement
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage passing extra custom parameters to personalize.
-
- A specific language to get the SystemMessage for.
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- Reference to the user used to personalize the message.
- The root name of the Resource File where the localized
- text can be found
- An ArrayList with replacements for custom tags.
- The message body with all tags replaced.
-
- Custom tags are of the form [Custom:n], where n is the zero based index which
- will be used to find the replacement value in Custom parameter.
-
-
- [Vicenç] 05/07/2004 Documented
- [cnurse] 10/06/2004 Moved from SystemMessages to Localization
- [DanCaron] 10/27/2004 Simplified Profile replacement, added Membership replacement
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage passing extra custom parameters to personalize.
-
- A specific language to get the SystemMessage for.
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- Reference to the user used to personalize the message.
- The root name of the Resource File where the localized
- text can be found
- An ArrayList with replacements for custom tags.
- prefix for custom tags
- UserID of the user accessing the system message
- The message body with all tags replaced.
-
- Custom tags are of the form [Custom:n], where n is the zero based index which
- will be used to find the replacement value in Custom parameter.
-
-
- [Vicenç] 05/07/2004 Documented
- [cnurse] 10/06/2004 Moved from SystemMessages to Localization
- [DanCaron] 10/27/2004 Simplified Profile replacement, added Membership replacement
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a SystemMessage passing extra custom parameters to personalize.
-
- A specific language to get the SystemMessage for.
- The portal settings for the portal to which the message will affect.
- The message tag which identifies the SystemMessage.
- Reference to the user used to personalize the message.
- The root name of the Resource File where the localized
- text can be found
- An ArrayList with replacements for custom tags.
- An IDictionary with replacements for custom tags.
- prefix for custom tags
- UserID of the user accessing the system message
- The message body with all tags replaced.
-
- Custom tags are of the form [Custom:n], where n is the zero based index which
- will be used to find the replacement value in Custom parameter.
-
-
- [cnurse] 09/09/2009 created
-
- -----------------------------------------------------------------------------
-
-
-
- LoadCultureDropDownList loads a DropDownList with the list of supported cultures
- based on the languages defined in the supported locales file
-
- DropDownList to load
- Format of the culture to display. Must be one the CultureDropDownTypes values.
- for list of allowable values
- Name of the default culture to select
-
- -----------------------------------------------------------------------------
-
- LoadTimeZoneDropDownList loads a drop down list with the Timezones
-
- The list to load
- Language
- The selected Time Zone
-
- [cnurse] 10/29/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Localizes ModuleControl Titles
-
- ModuleControl
-
- Localized control title if found
-
-
- Resource keys are: ControlTitle_[key].Text
- Key MUST be lowercase in the resource file
-
-
- [vmasanas] 08/11/2004 Created
- [cnurse] 11/28/2008 Modified Signature
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LocalizeDataGrid creates localized Headers for a DataGrid
-
- Grid to localize
- The root name of the Resource File where the localized
- text can be found
-
- [cnurse] 9/10/2004 Created
-
- -----------------------------------------------------------------------------
-
-
-
- Localizes headers and fields on a DetailsView control
-
-
- The root name of the resource file where the localized
- texts can be found
-
-
-
- Localizes headers and fields on a GridView control
-
- Grid to localize
- The root name of the resource file where the localized
- texts can be found
-
-
- -----------------------------------------------------------------------------
-
- Localizes the "Built In" Roles
-
-
- Localizes:
- -DesktopTabs
- -BreadCrumbs
-
-
- [cnurse] 02/01/2005 Created
-
- -----------------------------------------------------------------------------
-
-
-
- The Locale class is a custom business object that represents a locale, which is the language and country combination.
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the ID of the Authentication System
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the PackageID for the Authentication System
-
-
- [cnurse] 07/31/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets a flag that determines whether the Authentication System is enabled
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the type (name) of the Authentication System (eg DNN, OpenID, LiveID)
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the url for the Settings Control
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the url for the Login Control
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the url for the Logoff Control
-
-
- [cnurse] 07/23/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a RoleInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 03/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 03/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationInfo class provides the Entity Layer for the
- Authentication Systems.
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the RoleGroup Id
-
- An Integer representing the Id of the RoleGroup
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Portal Id for the RoleGroup
-
- An Integer representing the Id of the Portal
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the RoleGroup Name
-
- A string representing the Name of the RoleGroup
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an sets the Description of the RoleGroup
-
- A string representing the description of the RoleGroup
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Roles for this Role Group
-
- A Boolean
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a RoleGroupInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 03/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 03/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an XmlSchema for the RoleGroupInfo
-
-
- [cnurse] 03/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a Roles from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 03/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a RoleGroupInfo from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 03/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes a RoleGroupInfo to an XmlWriter
-
- The XmlWriter to use
-
- [cnurse] 03/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Security.Roles
- Class: RoleGroupInfo
- -----------------------------------------------------------------------------
-
- The RoleGroupInfo class provides the Entity Layer RoleGroup object
-
-
- [cnurse] 01/03/2006 made compatible with .NET 2.0
-
- -----------------------------------------------------------------------------
-
-
-
- This method
-
-
-
-
-
-
- Creates an RSS Item
-
-
-
-
-
-
- The PreRender event is used to set the Caching Policy for the Feed. This mimics the behavior from the
- OutputCache directive in the old Rss.aspx file. @OutputCache Duration="60" VaryByParam="moduleid"
-
-
-
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new Pane object from the Control in the Skin
-
- The HtmlContainerControl in the Skin.
-
- [cnurse] 12/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new Pane object from the Control in the Skin
-
- The name (ID) of the HtmlContainerControl
- The HtmlContainerControl in the Skin.
-
- [cnurse] 12/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Containers.
-
-
- [cnurse] 12/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the name (ID) of the Pane
-
-
- [cnurse] 12/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the HtmlContainerControl
-
-
- [cnurse] 12/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PortalSettings of the Portal
-
-
- [cnurse] 12/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LoadContainerByPath gets the Container from its Url(Path)
-
- The Url to the Container control
- A Container
-
- [cnurse] 12/05/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LoadModuleContainer gets the Container for a Module
-
- The Module
- A Container
-
- [cnurse] 12/05/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ModuleMoveToPanePostBack excutes when a module is moved by Drag-and-Drop
-
- A ClientAPIPostBackEventArgs object
-
- [cnurse] 12/05/2007 Moved from Skin.vb
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- InjectModule injects a Module (and its container) into the Pane
-
- The Module
-
- [cnurse] 12/05/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ProcessPane processes the Attributes for the PaneControl
-
-
- [cnurse] 12/05/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Skins
- Class : Pane
- -----------------------------------------------------------------------------
-
- The Pane class represents a Pane within the Skin
-
-
-
-
- [cnurse] 12/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Skins
- Class : ISkinControl
- -----------------------------------------------------------------------------
-
- ISkinControl provides a common INterface for Skin Controls
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Actions for this module context
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Module Configuration (ModuleInfo) for this context
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The EditMode property is used to determine whether the user is in the
- Administrator role
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the HelpUrl for this context
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the module is Editable (in Admin mode)
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the module ID for this context
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the settings for this context
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the tab ID for this context
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the tabnmodule ID for this context
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new ModuleInstanceContext
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new ModuleInstanceContext
-
- The Module Control for this context
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether this module is on a Host Menu
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the portal Settings for this module
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the portal Alias for this module
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the portal Id for this module
-
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Builds the URL for an "Edit" control
-
-
- [cnurse] 03/02/2006 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Builds the URL for an "Edit" control
-
- The key for the Control (ctl=key)
-
- [cnurse] 03/02/2006 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Builds the URL for an "Edit" control
-
- The name of Querysstring Paramater
- The value of a Querystring Parameter
-
- [cnurse] 03/02/2006 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Builds the URL for an "Edit" control
-
- The key for the Control (ctl=key)
- The name of Querysstring Paramater
- The value of a Querystring Parameter
-
- [cnurse] 03/02/2006 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Builds the URL for an "Edit" control
-
- The key for the Control (ctl=key)
- The name of Querysstring Paramater
- The value of a Querystring Parameter
- A collection of extra Parameters
-
- [cnurse] 03/02/2006 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Next Action ID
-
-
-
-
- [cnurse] 03/02/2006 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddHelpActions Adds the Help actions to the Action Menu
-
-
-
-
- [cnurse] 05/12/2005 Documented
- [cnurse] 01/19/2006 Moved from ActionBase
- [cnurse] 12/24/2007 Renamed (from SetHelpVisibility)
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddMenuMoveActions Adds the Move actions to the Action Menu
-
-
-
-
- [cnurse] 01/04/2008 Refactored from LoadActions
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetActionsCount gets the current number of actions
-
- The actions collection to count.
- The current count
-
- [cnurse] 01/04/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LoadActions loads the Actions collections
-
-
-
-
- [cnurse] 01/19/2006 created
-
- -----------------------------------------------------------------------------
-
-
-
- Provides context data for a particular instance of a module
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Modules
- Class : IModuleControl
- -----------------------------------------------------------------------------
-
- IModuleControl provides a common Interface for Module Controls
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the underlying base control for this ModuleControl
-
- A String
-
- [cnurse] 12/17/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Path for this control (used primarily for UserControls)
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Name for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the local resource file for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Module Context for this control
-
- A ModuleInstanceContext
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Modules
- Class : ModuleControlBase
- -----------------------------------------------------------------------------
-
- ModuleControlBase is a base class for Module Controls that inherits from the
- Control base class. As with all MontrolControl base classes it implements
- IModuleControl.
-
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates a Module Host control using the ModuleConfiguration for the Module
-
-
-
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the attached ModuleControl
-
- An IModuleControl
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the current POrtal Settings
-
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- ----------------------------------------------------------------------------
-
- Gets a flag that indicates whether the Module Content should be displayed
-
- A Boolean
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a flag that indicates whether the Module is in View Mode
-
- A Boolean
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LoadModuleControl loads the ModuleControl (PortalModuelBase)
-
-
- [cnurse] 12/15/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LoadUpdatePanel optionally loads an AJAX Update Panel
-
-
- [cnurse] 12/16/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a flag that indicates whether the Module Instance supports Caching
-
- A Boolean
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Trys to load previously cached Module Content
-
- A Boolean that indicates whether the cahed content was loaded
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CreateChildControls builds the control tree
-
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- RenderContents renders the contents of the control to the output stream
-
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Modules
- Class : ModuleHost
- -----------------------------------------------------------------------------
-
- ModuleHost hosts a Module Control (or its cached Content).
-
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Modules
- Class : ModuleCachingType
- -----------------------------------------------------------------------------
-
- ModuleCachingType is an enum that provides the caching types for Module Content
-
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the underlying base control for this ModuleControl
-
- A String
-
- [cnurse] 12/17/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Path for this control (used primarily for UserControls)
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Name for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the local resource file for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Module Context for this control
-
- A ModuleInstanceContext
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Modules
- Class : ModuleUserControlBase
- -----------------------------------------------------------------------------
-
- ModuleUserControlBase is a base class for Module Controls that inherits from the
- UserControl base class. As with all MontrolControl base classes it implements
- IModuleControl.
-
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new CachedModuleControl
-
- The cached Content for this control
-
- [cnurse] 12/17/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the underlying base control for this ModuleControl
-
- A String
-
- [cnurse] 12/17/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Path for this control (used primarily for UserControls)
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Name for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the local resource file for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Module Context for this control
-
- A ModuleInstanceContext
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Modules
- Class : CachedModuleControl
- -----------------------------------------------------------------------------
-
- CachedModuleControl represents a cached "ModuleControl". It inherits from
- Literal and implements the IModuleControl interface
-
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ActionRoot
-
- A ModuleActionCollection
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Provider Control
-
- A NavigationProvider
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Expansion Depth for the Control
-
- An Integer
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Path to the Script Library for the provider
-
- A String
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets whether the Menu should be populated from the client
-
- A Boolean
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Name of the provider to use
-
- A String
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- BindMenu binds the Navigation Provider to the Node Collection
-
- The Nodes collection to bind
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ProcessNodes proceses a single node and its children
-
- The Node to process
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SetMenuDefaults sets up the default values
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- BindMenu binds the Navigation Provider to the Node Collection
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnAction raises the Action Event
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnInit runs during the controls initialisation phase
-
-
- [cnurse] 01/02/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnLoad runs during the controls load phase
-
-
- [cnurse] 01/02/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnPreRender runs during the controls pre-render phase
-
-
- [cnurse] 01/02/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- MenuItem_Click handles the Menu Click event
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ProviderControl_PopulateOnDemand handles the Populate On Demand Event
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ActionManager instance for this Action control
-
- An ActionManager object
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ModuleControl instance for this Action control
-
- An IModuleControl object
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Containers
- Class : ActionsMenu
- -----------------------------------------------------------------------------
-
- ActionsMenu provides a menu for a collection of actions.
-
-
- ActionsMenu inherits from CompositeControl, and implements the IActionControl
- Interface. It uses the Navigation Providers to implement the Menu.
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Containers
- Class : IActionControl
- -----------------------------------------------------------------------------
-
- IActionControl provides a common INterface for Action Controls
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ModuleActionCollection to bind to the list
-
- A ModuleActionCollection
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets the Separator between Buttons
-
- Defaults to 2 non-breaking spaces
- A String
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets the Command Name
-
- Maps to ModuleActionType in DotNetNuke.Entities.Modules.Actions
- A String
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets whether the icon is displayed
-
- Defaults to False
- A Boolean
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets whether the link is displayed
-
- Defaults to True
- A Boolean
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets the Icon used
-
- Defaults to the icon defined in Action
- A String
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnAction raises the Action Event
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnLoad runs when the control is loaded into the Control Tree
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ActionButtonClick handles the Action event of the contained ActionCommandButton(s)
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ActionManager instance for this Action control
-
- An ActionManager object
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ModuleControl instance for this Action control
-
- An IModuleControl object
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Containers
- Class : ActionButtonList
- -----------------------------------------------------------------------------
-
- ActionButtonList provides a list of buttons for a group of actions of the same type.
-
-
- ActionButtonList inherits from CompositeControl, and implements the IActionControl
- Interface. It uses a single ActionCommandButton for each Action.
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new ActionManager
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Action Control that is connected to this ActionManager instance
-
- An IActionControl object
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ModuleInstanceContext instance that is connected to this ActionManager
- instance
-
- A ModuleInstanceContext object
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ClearCache clears the Module cache
-
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Delete deletes the associated Module
-
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DoAction redirects to the Url associated with the Action
-
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- MoveToPane moves the Module to the relevant Pane
-
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- MoveUpDown moves the Module within its Pane.
-
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DisplayControl determines whether the associated Action control should be
- displayed
-
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetAction gets the action associated with the commandName
-
- The command name
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetAction gets the action associated with the id
-
- The Id
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetClientScriptURL gets the client script to attach to the control's client
- side onclick event
-
- The Action
- The Control
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- IsVisible determines whether the action control is Visible
-
- The Action
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ProcessAction processes the action
-
- The Id of the Action
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ProcessAction processes the action
-
- The Action
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Containers
- Class : ActionManager
- -----------------------------------------------------------------------------
-
- ActionManager is a helper class that provides common Action Behaviours that can
- be used by any IActionControl implementation
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ModuleAction for this Action control
-
- A ModuleAction object
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CreateChildControls builds the control tree
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnAction raises the Action Event
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnButtonClick runs when the underlying CommandButton is clicked
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnPreRender runs when just before the Render phase of the Page Lifecycle
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ActionManager instance for this Action control
-
- An ActionManager object
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ModuleControl instance for this Action control
-
- An IModuleControl object
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Containers
- Class : ActionCommandButton
- -----------------------------------------------------------------------------
-
- ActionCommandButton provides a button for a single action.
-
-
- ActionBase inherits from CommandButton, and implements the IActionControl Interface.
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Actions Collection
-
- A ModuleActionCollection
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ActionRoot
-
- A ModuleActionCollection
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ModuleContext
-
- A ModuleInstanceContext
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PortalSettings
-
- A PortalSettings object
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DisplayControl determines whether the control should be displayed
-
-
- [cnurse] 12/23/2007 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- OnAction raises the Action Event for this control
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ProcessAction processes the action event
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Page_Load runs when the class is loaded
-
-
-
-
- [cnurse] 05/12/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ActionManager instance for this Action control
-
- An ActionManager object
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ModuleControl instance for this Action control
-
- An IModuleControl object
-
- [cnurse] 12/15/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Containers
- Class : ActionBase
- -----------------------------------------------------------------------------
-
- ActionBase is an abstract base control for Action objects that inherit from UserControl.
-
-
- ActionBase inherits from UserControl, and implements the IActionControl Interface
-
-
- [cnurse] 10/07/2004 Documented
- [cnurse] 12/15/2007 Refactored
-
- -----------------------------------------------------------------------------
-
-
-
- getQSParams builds up a new querystring. This is necessary
- in order to prep for navigateUrl.
- we don't ever want a tabid, a ctl and a language parameter in the qs
- also, the portalid param is not allowed when the tab is a supertab
- (because NavigateUrl adds the portalId param to the qs)
-
-
- [erikvb] 20070814 added
-
-
-
- newUrl returns the new URL based on the new language.
- Basically it is just a call to NavigateUrl, with stripped qs parameters
-
-
-
- [erikvb] 20070814 added
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets the Command Name
-
- Maps to ModuleActionType in DotNetNuke.Entities.Modules.Actions
- A String
-
- [cnurse] 6/29/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets the CSS Class
-
- Defaults to 'CommandButton'
- A String
-
- [cnurse] 6/29/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets whether the link is displayed
-
- Defaults to True
- A Boolean
-
- [cnurse] 6/29/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets whether the icon is displayed
-
- Defaults to False
- A Boolean
-
- [cnurse] 6/29/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets the Icon used
-
- Defaults to the icon defined in Action
- A String
-
- [cnurse] 6/29/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets or sets the Separator between Buttons
-
- Defaults to 2 non-breaking spaces
- A String
-
- [cnurse] 6/29/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Action_Click responds to an Action Event in the contained actionButtonList
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CreateChildControls builds the control tree
-
-
- [cnurse] 12/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Containers
- Class : ActionButton
- -----------------------------------------------------------------------------
-
- ActionButton provides a button (or group of buttons) for action(s).
-
-
- ActionBase inherits from UserControl, and implements the IActionControl Interface.
-
-
- [cnurse] 10/07/2004 Documented
- [cnurse] 12/15/2007 Deprectaed and Refactored to use ActionButtonList
- by Containment
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CacheMappedDirectory caches the Portal Mapped Directory(s)
-
-
-
-
- [cnurse] 1/27/2005 Moved back to App_Start from Caching Module
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CheckVersion determines whether the App is synchronized with the DB
-
-
-
-
- [cnurse] 2/17/2005 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LogStart logs the Application Start Event
-
-
-
-
- [cnurse] 1/27/2005 Moved back to App_Start from Logging Module
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- StartScheduler starts the Scheduler
-
-
-
-
- [cnurse] 1/27/2005 Moved back to App_Start from Scheduling Module
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LogEnd logs the Application Start Event
-
-
-
-
- [cnurse] 1/28/2005 Moved back to App_End from Logging Module
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- StopScheduler stops the Scheduler
-
-
-
-
- [cnurse] 1/28/2005 Moved back to App_End from Scheduling Module
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Provider Properties can be edited
-
- A Boolean
-
- [cnurse] 03/02/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Security.Profile
- Class: ProfileProviderConfig
- -----------------------------------------------------------------------------
-
- The ProfileProviderConfig class provides a wrapper to the Profile providers
- configuration
-
-
-
-
- [cnurse] 03/09/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Provider Properties can be edited
-
- A Boolean
-
- [cnurse] 03/02/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the maximum number of invlaid attempts to login are allowed
-
- A Boolean.
-
- [cnurse] 03/02/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Mimimum no of Non AlphNumeric characters required
-
- An Integer.
-
- [cnurse] 02/07/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Mimimum Password Length
-
- An Integer.
-
- [cnurse] 02/07/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the window in minutes that the maxium attempts are tracked for
-
- A Boolean.
-
- [cnurse] 03/02/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Password Format
-
- A PasswordFormat enumeration.
-
- [cnurse] 02/07/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Users's Password can be reset
-
- A Boolean.
-
- [cnurse] 03/02/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Users's Password can be retrieved
-
- A Boolean.
-
- [cnurse] 03/02/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a Regular Expression that deermines the strength of the password
-
- A String.
-
- [cnurse] 02/07/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether a Question/Answer is required for Password retrieval
-
- A Boolean.
-
- [cnurse] 02/07/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether a Unique Email is required
-
- A Boolean.
-
- [cnurse] 02/06/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Security.Membership
- Class: MembershipProviderConfig
- -----------------------------------------------------------------------------
-
- The MembershipProviderConfig class provides a wrapper to the Membership providers
- configuration
-
-
-
-
- [cnurse] 03/02/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ScheduleStatusSortRemainingTimeDescending Class is a custom IComparer Implementation
- used to sort the Schedule Items
-
-
-
-
- [cnurse] 9/28/2004 Updated to reflect design changes for Help, 508 support
- and localisation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ScheduleHistorySortStartDate Class is a custom IComparer Implementation
- used to sort the Schedule Items
-
-
-
-
- [cnurse] 9/28/2004 Updated to reflect design changes for Help, 508 support
- and localisation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallPackage instance as defined by the
- Parameters
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallPackage instance
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ID of this package
-
- An Integer
-
- [cnurse] 07/26/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the ID of this portal
-
- An Integer
-
- [cnurse] 09/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Owner of this package
-
- A String
-
- [cnurse] 03/26/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Organisation for this package
-
- A String
-
- [cnurse] 03/26/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Url for this package
-
- A String
-
- [cnurse] 03/26/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Email for this package
-
- A String
-
- [cnurse] 03/26/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Description of this package
-
- A String
-
- [cnurse] 07/26/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Files that are included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the FriendlyName of this package
-
- A String
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated InstallerInfo
-
- An InstallerInfo object
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Installed Version of the Package
-
- A System.Version
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the InstallMode
-
- An InstallMode value
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets whether this package is a "system" Package
-
- A String
-
- [cnurse] 02/19/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Package is Valid
-
- A Boolean value
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the License of this package
-
- A String
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Logger
-
- An Logger object
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Manifest of this package
-
- A String
-
- [cnurse] 07/26/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Name of this package
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the ReleaseNotes of this package
-
- A String
-
- [cnurse] 01/07/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Type of this package
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Version of this package
-
- A System.Version
-
- [cnurse] 07/26/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AttachInstallerInfo method attachs an InstallerInfo instance to the Package
-
- The InstallerInfo instance to attach
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageInfo class represents a single Installer Package
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageController class provides the business class for the packages
-
-
-
-
- [cnurse] 07/26/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Css Class used for Error Log Entries
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Css Class used for Log Entries that should be highlighted
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a List of Log Entries
-
- A List of LogEntrys
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Css Class used for normal Log Entries
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Flag that indicates whether the Installation was Valid
-
- A List of LogEntrys
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AddFailure method adds a new LogEntry of type Failure to the Logs collection
-
- This method also sets the Valid flag to false
- The description of the LogEntry
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AddFailure method adds a new LogEntry of type Failure to the Logs collection
-
- This method also sets the Valid flag to false
- The Exception
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AddInfo method adds a new LogEntry of type Info to the Logs collection
-
- The description of the LogEntry
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AddWarning method adds a new LogEntry of type Warning to the Logs collection
-
- The description of the LogEntry
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The EndJob method adds a new LogEntry of type EndJob to the Logs collection
-
- The description of the LogEntry
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetLogsTable formats log entries in an HtmlTable
-
-
- [jbrinkman] 24/11/2004 Created new method. Moved from WebUpload.ascx.vb
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The StartJob method adds a new LogEntry of type StartJob to the Logs collection
-
- The description of the LogEntry
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Logger class provides an Installer Log
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor builds a LogEntry from its type and description
-
-
-
- The description (detail) of the entry
- The type of LogEntry
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the type of LogEntry
-
- A LogType
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the description of LogEntry
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LogEntry class provides a single entry for the Installer Log
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallFile instance from a ZipInputStream and a ZipEntry
-
- The ZipInputStream is read into a byte array (Buffer), and the ZipEntry is used to
- set up the properties of the InstallFile class.
- The ZipInputStream
- The ZipEntry
- An INstallerInfo instance
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallFile instance
-
- The fileName of the File
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallFile instance
-
- The fileName of the File
- An INstallerInfo instance
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallFile instance
-
- The fileName of the File
- An INstallerInfo instance
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallFile instance
-
- The file name of the File
- The file path of the file
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Action for this file
-
- A string
-
- [cnurse] 09/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the location of the backup file
-
- A string
-
- [cnurse] 08/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the location of the backup folder
-
- A string
-
- [cnurse] 08/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the File Extension of the file
-
- A string
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Full Name of the file
-
- A string
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated InstallerInfo
-
- An InstallerInfo object
-
- [cnurse] 08/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Name of the file
-
- A string
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Path of the file
-
- A string
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the source file name
-
- A string
-
- [cnurse] 01/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the location of the temporary file
-
- A string
-
- [cnurse] 08/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Type of the file
-
- An InstallFileType Enumeration
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Version of the file
-
- A System.Version
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ParseFileName parses the ZipEntry metadata
-
- A String representing the file name
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadZip method reads the zip stream and parses the ZipEntry metadata
-
- A ZipStream containing the file content
- A ZipEntry containing the file metadata
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SetVersion method sets the version of the file
-
- The version of the file
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallFile class represents a single file in an Installer Package
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the BasePath for the files
-
- The Base Path is relative to the WebRoot
- A String
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("files")
-
- A String
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Files that are included in this component
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the default Path for the file - if not present in the manifest
-
- A String
-
- [cnurse] 08/10/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("file")
-
- A String
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PhysicalBasePath for the files
-
- A String
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Packages files are deleted when uninstalling the
- package
-
- A Boolean value
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Installer supports Manifest only installs
-
- A Boolean
-
- [cnurse] 02/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CommitFile method commits a single file.
-
- The InstallFile to commit
-
- [cnurse] 08/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteFile method deletes a single file.
-
- The InstallFile to delete
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallFile method installs a single file.
-
- The InstallFile to install
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a flag that determines what type of file this installer supports
-
- The type of file being processed
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProcessFile method determines what to do with parsed "file" node
-
- The file represented by the node
- The XPathNavigator representing the node
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadCustomManifest method reads the custom manifest items (that subclasses
- of FileInstaller may need)
-
- The XPathNavigator representing the node
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifestItem method reads a single node
-
- The XPathNavigator representing the node
- Flag that determines whether a check should be made
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The RollbackFile method rolls back the install of a single file.
-
- For new installs this removes the added file. For upgrades it restores the
- backup file created during install
- The InstallFile to commit
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstallFile method unInstalls a single file.
-
- The InstallFile to unInstall.
-
- [cnurse] 01/07/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
- In the case of Files this is not neccessary
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the file component
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file for the file compoent.
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the file component in the event
- that one of the other components fails
-
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the file component
-
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The FileInstaller installs File Components to a DotNetNuke site
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The GetInstaller method instantiates the relevant Component Installer
-
- The type of Installer
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The GetInstaller method instantiates the relevant Component Installer
-
- The manifest (XPathNavigator) for the component
- The associated PackageInfo instance
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallerFactory is a factory class that is used to instantiate the
- appropriate Component Installer
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the base Install Script (if present)
-
- An InstallFile
-
- [cnurse] 05/20/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the collection of Install Scripts
-
- A List(Of InstallFile)
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the collection of UnInstall Scripts
-
- A List(Of InstallFile)
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("scripts")
-
- A String
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("script")
-
- A String
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Upgrade Script (if present)
-
- An InstallFile
-
- [cnurse] 07/14/2009 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a flag that determines what type of file this installer supports
-
- The type of file being processed
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProcessFile method determines what to do with parsed "file" node
-
- The file represented by the node
- The XPathNavigator representing the node
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
- In the case of Files this is not neccessary
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the script component
-
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the script component in the event
- that one of the other components fails
-
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the script component
-
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ScriptInstaller installs Script Components to a DotNetNuke site
-
-
-
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Install config changes
-
- A String
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Target Config XmlDocument
-
- An XmlDocument
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Target Config file to change
-
- A String
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the UnInstall config changes
-
- A String
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the config component
-
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file for the config compoent.
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the file component in the event
- that one of the other components fails
-
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the config component
-
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ConfigInstaller installs Config changes
-
-
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteAuthentiation method deletes the Authentication System
- from the data Store.
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
- In the case of Authentication systems this is not neccessary
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the authentication component
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file for the Authentication compoent.
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the component in the event
- that one of the other components fails
-
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the authentication component
-
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationInstaller installs Authentication Service Components to a DotNetNuke site
-
-
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("assemblies")
-
- A String
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the default Path for the file - if not present in the manifest
-
- A String
-
- [cnurse] 08/10/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("assembly")
-
- A String
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PhysicalBasePath for the assemblies
-
- A String
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteFile method deletes a single assembly.
-
- The InstallFile to delete
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a flag that determines what type of file this installer supports
-
- The type of file being processed
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallFile method installs a single assembly.
-
- The InstallFile to install
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AssemblyInstaller installs Assembly Components to a DotNetNuke site
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Completed flag
-
- A Boolean value
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the InstallMode
-
- An InstallMode value
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Logger
-
- An Logger object
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated Package
-
- An PackageInfo object
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Files that are included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Physical Path to the root of the Site (eg D:\Websites\DotNetNuke")
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Installer supports Manifest only installs
-
- A Boolean
-
- [cnurse] 02/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Type of the component
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Version of the Component
-
- A System.Version
-
- [cnurse] 02/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ComponentInstallerBase is a base class for all Component Installers
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallerInfo instance
-
-
- [cnurse] 07/26/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallerInfo instance from a
- string representing the physical path to the root of the site
-
- The physical path to the root of the site
-
- [cnurse] 02/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallerInfo instance from a Stream and a
- string representing the physical path to the root of the site
-
- The Stream to use to create this InstallerInfo instance
- The physical path to the root of the site
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallerInfo instance from a string representing
- the physical path to the temporary install folder and a string representing
- the physical path to the root of the site
-
- The physical path to the zip file containg the package
- The manifest filename
- The physical path to the root of the site
-
- [cnurse] 08/13/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallerInfo instance from a PackageInfo object
-
- The PackageInfo instance
- The physical path to the root of the site
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Files that are included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the package contains Valid Files
-
- A Boolean
-
- [cnurse] 09/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Package is installed
-
- A Boolean value
-
- [cnurse] 09/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the InstallMode
-
- A InstallMode value
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Invalid File Extensions
-
- A String
-
- [cnurse] 01/12/2009 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the File Extension WhiteList is ignored
-
- A Boolean value
-
- [cnurse] 05/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Installer is in legacy mode
-
-
- [cnurse] 08/20/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the InstallerInfo instance is Valid
-
- A Boolean value
-
- [cnurse] 08/13/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated Logger
-
- A Logger
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Manifest File for the Package
-
- An InstallFile
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Id of the package after installation (-1 if fail)
-
- An Integer
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Physical Path to the root of the Site (eg D:\Websites\DotNetNuke")
-
- A String
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Id of the current portal (-1 if Host)
-
- An Integer
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Package Install is being repaird
-
- A Boolean value
-
- [cnurse] 09/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the security Access Level of the user that is calling the INstaller
-
- A SecurityAccessLevel enumeration
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Temporary Install Folder used to unzip the archive (and to place the
- backups of existing files) during InstallMode
-
- A String
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadZipStream reads a zip stream, and loads the Files Dictionary
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallerInfo class holds all the information associated with a
- Installation.
-
-
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new Installer instance from a string representing
- the physical path to the temporary install folder and a string representing
- the physical path to the root of the site
-
- The physical path to the zip file containg the package
- The manifest filename
- The physical path to the root of the site
- Flag that determines whether the manifest will be loaded
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new Installer instance from a Stream and a
- string representing the physical path to the root of the site
-
- The Stream to use to create this InstallerInfo instance
- The physical path to the root of the site
- Flag that determines whether the manifest will be loaded
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new Installer instance from a Stream and a
- string representing the physical path to the root of the site
-
- The Stream to use to create this InstallerInfo instance
- The physical path to the root of the site
- Flag that determines whether the manifest will be loaded
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new Installer instance from a PackageInfo object
-
- The PackageInfo instance
- The physical path to the root of the site
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated InstallerInfo object
-
- An InstallerInfo
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the associated InstallerInfo is valid
-
- True - if valid, False if not
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
-
- Gets and sets whether there are any errors in parsing legacy packages
-
-
-
-
-
- -----------------------------------------------------------------------------
-
- Gets a SortedList of Packages that are included in the Package Zip
-
- A SortedList(Of Integer, PackageInstaller)
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets
-
- A Dictionary(Of String, PackageInstaller)
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallPackages method installs the packages
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Logs the Install event to the Event Log
-
- The name of the package
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProcessPackages method processes the packages nodes in the manifest
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstallPackages method uninstalls the packages
-
- A flag that indicates whether the files should be
- deleted
-
- [cnurse] 07/25/2007 created
- [cnurse] 01/31/2008 added deleteFiles parameter
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the feature.
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file and parses it into packages.
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the feature
-
- A flag that indicates whether the files should be
- deleted
-
- [cnurse] 07/25/2007 created
- [cnurse] 01/31/2008 added deleteFiles parameter
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Installer class provides a single entrypoint for Package Installation
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The TypeDependency determines whether the dependent type is installed
-
-
-
-
- [cnurse] 09/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PermissionsDependency determines whether the DotNetNuke site has the
- corretc permissions
-
-
-
-
- [cnurse] 09/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageDependency determines whether the dependent package is installed
-
-
-
-
- [cnurse] 09/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The IDependency Interface defines the contract for a Package Dependency
-
-
-
-
- [cnurse] 09/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The GetDependency method instantiates (and returns) the relevant Dependency
-
- The manifest (XPathNavigator) for the dependency
-
- [cnurse] 09/02/2007 created
- [bdukes] 03/04/2009 added case-insensitivity to type attribute, added InvalidDependency for dependencies that can't be created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DependencyFactory is a factory class that is used to instantiate the
- appropriate Dependency
-
-
-
-
- [cnurse] 09/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DependencyBase is a base class for Installer Dependencies
-
-
-
-
- [cnurse] 09/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CoreVersionDependency determines whether the CoreVersion is correct
-
-
-
-
- [cnurse] 09/02/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new InstallPackage instance
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Description of this package type
-
- A String
-
- [cnurse] 09/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the EditorControlSrc of this package type
-
- A String
-
- [cnurse] 01/04/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Name of this package type
-
- A String
-
- [cnurse] 09/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the security Access Level required to install this package type
-
- A SecurityAccessLevel enumeration
-
- [cnurse] 09/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageType class represents a single Installer Package Type
-
-
-
-
- [cnurse] 09/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("skinFiles")
-
- A String
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("skinFile")
-
- A String
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PhysicalBasePath for the skin files
-
- A String
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the root folder for the Skin
-
- A String
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the collection of Skin Files
-
- A List(Of InstallFile)
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the SkinName Node ("skinName")
-
- A String
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the RootName of the Skin
-
- A String
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Type of the Skin
-
- A String
-
- [cnurse] 02/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteSkinPackage method deletes the Skin Package
- from the data Store.
-
-
- [cnurse] 02/08/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProcessFile method determines what to do with parsed "file" node
-
- The file represented by the node
- The XPathNavigator representing the node
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadCustomManifest method reads the custom manifest items
-
- The XPathNavigator representing the node
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstallFile method unInstalls a single file.
-
- The InstallFile to unInstall.
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the skin component
-
-
- [cnurse] 02/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the component in the event
- that one of the other components fails
-
-
- [cnurse] 02/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the skin component
-
-
- [cnurse] 02/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SkinInstaller installs Skin Components to a DotNetNuke site
-
-
-
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("containerFiles")
-
- A String
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("containerFile")
-
- A String
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the SkinName Node ("containerName")
-
- A String
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the RootName of the Skin
-
- A String
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Type of the Skin
-
- A String
-
- [cnurse] 02/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ContainerInstaller installs Container Components to a DotNetNuke site
-
-
-
-
- [cnurse] 08/23/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CleanupFile method cleansup a single file.
-
- The InstallFile to clean up
-
- [cnurse] 09/05/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProcessFile method determines what to do with parsed "file" node
-
- The file represented by the node
- The XPathNavigator representing the node
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The RollbackFile method rolls back the cleanup of a single file.
-
- The InstallFile to commit
-
- [cnurse] 09/05/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
- In the case of Clenup this is not neccessary
-
- [cnurse] 09/05/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method cleansup the files
-
-
- [cnurse] 09/05/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the file component
-
- There is no uninstall for this component
-
- [cnurse] 09/05/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CleanupInstaller cleans up (removes) files from previous versions
-
-
-
-
- [cnurse] 09/05/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The StreamToStream method reads a source stream and wrtites it to a destination stream
-
- The Source Stream
- The Destination Stream
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The BackupFile method backs up a file to the backup folder
-
- The file to backup
- The basePath to the file
- A Logger to log the result
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CopyFile method copies a file from the temporary extract location.
-
- The file to copy
- The basePath to the file
- A Logger to log the result
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteFile method deletes a file.
-
- The file to delete
- The basePath to the file
- A Logger to log the result
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteFile method deletes a file.
-
- The file to delete
- The basePath to the file
- A Logger to log the result
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The GetLocalizedString method provides a conveniencewrapper around the
- Localization of Strings
-
- The localization key
- The localized string
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallURL method provides a utility method to build the correct url
- to install a package (and return to where you came from)
-
- The id of the tab you are on
- The type of package you are installing
- The localized string
-
- [cnurse] 07/26/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageWriterURL method provides a utility method to build the correct url
- to create a package (and return to where you came from)
-
- The ModuleContext of the module
- The id of the package you are packaging
- The localized string
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The RestoreFile method restores a file from the backup folder
-
- The file to restore
- The basePath to the file
- A Logger to log the result
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstallURL method provides a utility method to build the correct url
- to uninstall a package (and return to where you came from)
-
- The id of the tab you are on
- The id of the package you are uninstalling
- The localized string
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The WriteStream reads a source stream and writes it to a destination file
-
- The Source Stream
- The Destination file
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallerBase class is a Base Class for all Installer
- classes that need to use Localized Strings. It provides these strings
- as localized Constants.
-
-
-
-
- [cnurse] 07/05/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Initializes a new instance of the XmlMerge class.
-
-
-
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Initializes a new instance of the XmlMerge class.
-
-
-
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Initializes a new instance of the XmlMerge class.
-
-
-
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Initializes a new instance of the XmlMerge class.
-
-
-
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Source for the Config file
-
- An XmlDocument
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Sender (source) of the changes to be merged
-
- A String
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Target Config file
-
- An XmlDocument
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the File Name of the Target Config file
-
- A String
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Version of the changes to be merged
-
- A String
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UpdateConfig method processes the source file and updates the Target
- Config Xml Document.
-
- An Xml Document represent the Target Xml File
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UpdateConfig method processes the source file and updates the Target
- Config file.
-
- An Xml Document represent the Target Xml File
- The fileName for the Target Xml File - relative to the webroot
-
- [cnurse] 08/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UpdateConfigs method processes the source file and updates the various config
- files
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The XmlMerge class is a utility class for XmlSplicing config files
-
-
- [cnurse] 08/03/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the underlying base control for this ModuleControl
-
- A String
-
- [cnurse] 12/17/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Path for this control (used primarily for UserControls)
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Name for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the local resource file for this control
-
- A String
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Module Context for this control
-
- A ModuleInstanceContext
-
- [cnurse] 12/16/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CacheMethod property is used to store the Method used for this Module's
- Cache
-
-
-
-
- [cnurse] 04/28/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The EditMode property is used to determine whether the user is in the
- Administrator role
- Cache
-
-
-
-
- [cnurse] 01/19/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Helper method that can be used to add an ActionEventHandler to the Skin for this
- Module Control
-
-
-
-
- [cnurse] 17/9/2004 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Next Action ID
-
-
-
-
- [cnurse] 03/02/2006 Added Documentation
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CacheDirectory property is used to return the location of the "Cache"
- Directory for the Module
-
-
-
-
- [cnurse] 04/28/2005 Created
-
- -----------------------------------------------------------------------------
-
-
-
- -----------------------------------------------------------------------------
-
- The CacheFileName property is used to store the FileName for this Module's
- Cache
-
-
-
-
- [cnurse] 04/28/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Class : PortalModuleBase
-
- -----------------------------------------------------------------------------
-
- The PortalModuleBase class defines a custom base class inherited by all
- desktop portal modules within the Portal.
-
- The PortalModuleBase class defines portal specific properties
- that are used by the portal framework to correctly display portal modules
-
-
-
-
- [cnurse] 09/17/2004 Added Documentation
- Modified LocalResourceFile to be Writeable
- [cnurse] 10/21/2004 Modified Settings property to get both
- TabModuleSettings and ModuleSettings
- [cnurse] 12/15/2007 Refactored to support the new IModuleControl
- Interface
-
- -----------------------------------------------------------------------------
-
-
-
- Addressing Methods (personalized or hidden)
-
-
-
- Priority of emails to be sent
-
-
-
- Subject of the emails to be sent
-
- may contain tokens
-
-
- body text of the email to be sent
-
- may contain HTML tags and tokens. Side effect: sets BodyFormat autmatically
-
- format of body text for the email to be sent.
- by default activated, if tokens are found in Body and subject.
-
- address method for the email to be sent (TO or BCC)
- TO is default value
-
- portal alias http path to be used for links to images, ...
-
- UserInfo of the user sending the mail
- if not set explicitely, currentuser will be used
-
- email of the user to be shown in the mail as replyTo address
- if not set explicitely, sendingUser will be used
-
- shall duplicate email addresses be ignored? (default value: false)
- Duplicate Users (e.g. from multiple role selections) will always be ignored.
-
- Shall automatic TokenReplace be prohibited?
- default value: false
-
- Shall List of recipients appended to confirmation report?
- enabled by default.
-
- internal method to initialize used objects, depending on parameters of New() method
-
- Send bulkmail confirmation to admin
- number of email recipients
- number of messages sent, -1 if not determinable
- number of emails not sent
- Subject of BulkMail sent (to be used as reference)
- date/time, sendout started
- mail error texts
- List of recipients as formatted string
-
-
- check, if the user's language matches the current language filter
- Language of the user
- userlanguage matches current languageFilter
- if userlanguage is empty or filter not set, true is returned
-
- add a user to the userlist, if it is not already in there
- user to add
- list of key (either email addresses or userid's)
- List of users
- for use by Recipients method only
-
- create a new object with default settings only.
- not all properties can be set individually, use other overload, if you need to set ReplaceTokens to False or another portal alias in image paths.
-
- create a new object with individual settings.
- List of role names, to address members
- List of individual recipients
- Shall duplicate emails be ignored?
- Subject for Emails to be sent
- Email Body (plain Text or HTML)
- Body and Subjects may contain tokens to be replaced
-
- Specify SMTP server to be used
- name of the SMTP server
- authentication string (0: anonymous, 1: basic, 2: NTLM)
- username to log in SMTP server
- password to log in SMTP server
- SSL used to connect tp SMTP server
- always true
- if not called, values will be taken from host settings
-
- Add a single attachment file to the email
- path to file to attach
- secure storages are currently not supported
-
- Add a single recipient
- userinfo of user to add
- emaiol will be used for addressing, other properties might be used for TokenReplace
-
- Add all members of a role to recipient list
- name of a role, whose members shall be added to recipients
- emaiol will be used for addressing, other properties might be used for TokenReplace
-
- All bulk mail recipients, derived from role names and individual adressees
- List of userInfo objects, who receive the bulk mail
- user.Email used for sending, other properties might be used for TokenReplace
-
- Send bulkmail to all recipients according to settings
- Number of emails sent, null.integer if not determinable
- Detailed status report is sent by email to sending user
-
- Wrapper for Function SendMails
-
- -----------------------------------------------------------------------------
-
- SendTokenizedBulkEmail Class is a class to manage the sending of bulk mails
- that contains tokens, which might be replaced with individual user properties
-
-
-
-
- [sleupold] 8/15/2007 created to support tokens and localisation
- [sleupold] 9/09/2007 refactored interface for enhanced type safety
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UserControlBase class defines a custom base class inherited by all
- user controls within the Portal.
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The type of Object to create (data/navigation)
- The created Object
- Overload for creating an object from a Provider configured in web.config
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The type of Object to create (data/navigation)
- Caching switch
- The created Object
- Overload for creating an object from a Provider configured in web.config
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The type of Object to create (data/navigation)
- The namespace of the object to create.
- The assembly of the object to create.
- The created Object
- Overload for creating an object from a Provider including NameSpace and
- AssemblyName ( this allows derived providers to share the same config )
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The type of Object to create (data/navigation)
- The namespace of the object to create.
- The assembly of the object to create.
- Caching switch
- The created Object
- Overload for creating an object from a Provider including NameSpace and
- AssemblyName ( this allows derived providers to share the same config )
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The type of Object to create (data/navigation)
- The name of the Provider
- The namespace of the object to create.
- The assembly of the object to create.
- The created Object
- Overload for creating an object from a Provider including NameSpace,
- AssemblyName and ProviderName
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The type of Object to create (data/navigation)
- The name of the Provider
- The namespace of the object to create.
- The assembly of the object to create.
- Caching switch
- The created Object
- Overload for creating an object from a Provider including NameSpace,
- AssemblyName and ProviderName
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The fully qualified TypeName
- The Cache Key
- The created Object
- Overload that takes a fully-qualified typename and a Cache Key
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The fully qualified TypeName
- The Cache Key
- Caching switch
- The created Object
- Overload that takes a fully-qualified typename and a Cache Key
-
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates an object
-
- The type of object to create
-
- Generic version
-
- [cnurse] 10/13/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Framework
- Project : DotNetNuke
- Class : Reflection
- -----------------------------------------------------------------------------
-
- Library responsible for reflection
-
-
-
-
- [Nik Kalyani] 10/15/2004 Replaced brackets in parameter names
- [cnurse] 10/13/2005 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates the Page
-
-
- [cnurse] 11/30/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- PageStatePersister returns an instance of the class that will be used to persist the Page State
-
- A System.Web.UI.PageStatePersister
-
- [cnurse] 11/30/2005 Created
-
- -----------------------------------------------------------------------------
-
-
-
- ProcessControl peforms the high level localization for a single control and optionally it's children.
-
- Control to find the AttributeCollection on
- ArrayList that hold the controls that have been localized. This is later used for the removal of the key attribute.
- If true, causes this method to process children of this controls.
-
-
- GetControlAttribute looks a the type of control and does it's best to find an AttributeCollection.
-
- Control to find the AttributeCollection on
- ArrayList that hold the controls that have been localized. This is later used for the removal of the key attribute.
- A string containing the key for the specified control or null if a key attribute wasn't found
-
-
- RemoveKeyAttribute remove the key attribute from the control. If this isn't done, then the HTML output will have
- a bad attribute on it which could cause some older browsers problems.
-
- ArrayList that hold the controls that have been localized. This is later used for the removal of the key attribute.
-
-
-
-
- An EventArgs that controls the event data.
-
-
- IterateControls performs the high level localization for each control on the page.
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Framework
- Project: DotNetNuke
- Class: PageBase
- -----------------------------------------------------------------------------
-
- PageBase provides a custom DotNetNuke base class for pages
-
-
- [cnurse] 11/30/2006 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates the DiskPageStatePersister
-
-
- [cnurse] 11/30/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CacheDirectory property is used to return the location of the "Cache"
- Directory for the Portal
-
-
-
-
- [cnurse] 11/30/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The StateFileName property is used to store the FileName for the State
-
-
-
-
- [cnurse] 11/30/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Loads the Page State from the Cache
-
-
- [cnurse] 11/30/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Saves the Page State to the Cache
-
-
- [cnurse] 11/30/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Framework
- Project: DotNetNuke
- Class: DiskPageStatePersister
- -----------------------------------------------------------------------------
-
- DiskPageStatePersister provides a disk (stream) based page state peristence mechanism
-
-
- [cnurse] 11/30/2006 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Allows the scroll position on the page to be moved to the top of the passed in control.
-
- Control to scroll to
-
-
-
- [Jon Henning] 3/30/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Class : CDefault
-
- -----------------------------------------------------------------------------
-
-
-
-
-
- [sun1] 1/19/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Creates the CachePageStatePersister
-
-
- [cnurse] 11/30/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Loads the Page State from the Cache
-
-
- [cnurse] 11/30/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Saves the Page State to the Cache
-
-
- [cnurse] 11/30/2006 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Framework
- Project: DotNetNuke
- Class: CachePageStatePersister
- -----------------------------------------------------------------------------
-
- CachePageStatePersister provides a cache based page state peristence mechanism
-
-
- [cnurse] 11/30/2006 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- IsHostEnabled is used to determine whether the Host user has enabled AJAX.
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- IsEnabled can be used to determine if AJAX has been enabled already as we
- only need one Script Manager per page.
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- IsInstalled can be used to determine if AJAX is installed on the server
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- RegisterScriptManager must be used by developers to instruct the framework that AJAX is required on the page
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ScriptManagerControl provides a reference to the ScriptManager control on the page
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddScriptManager is used internally by the framework to add a ScriptManager control to the page
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- RemoveScriptManager will remove the ScriptManager control during Page Render if the RegisterScriptManager has not been called
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SetScriptManagerProperty uses reflection to set properties on the dynamically generated ScriptManager control
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdatePanelControl dynamically creates an instance of an UpdatePanel control
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Allows a control to be excluded from UpdatePanel async callback
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Wraps a control in an update panel
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateProgressControl dynamically creates an instance of an UpdateProgress control
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateProgressControl dynamically creates an instance of an UpdateProgress control
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateProgressControl dynamically creates an instance of an UpdateProgress control
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ContentTemplateContainerControl gets a reference to the ContentTemplateContainer control within an UpdatePanel
-
-
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a FolderInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 07/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 07/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetFoldersCallBack gets a Dictionary of Folders by Portal from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 07/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Class : FolderController
-
- -----------------------------------------------------------------------------
-
- Business Class that provides access to the Database for the functions within the calling classes
- Instantiates the instance of the DataProvider and returns the object, if any
-
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a File
-
- The Id of the Portal
- The stream to add
- The type of the content
- The length of the content
- The name of the folder
- A flag that dermines if the Input Stream should be closed.
- A flag that indicates whether the file cache should be cleared
- This method adds a new file
-
-
- [cnurse] 04/26/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a Folder
-
- The Id of the Portal
- The relative path of the folder
- The type of storage location
-
- [cnurse] 04/26/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Checks that the file name is valid
-
- The name of the file
-
- [cnurse] 04/26/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the filename for a file path
-
- The full name of the file
-
- [cnurse] 04/26/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates a File
-
- The original File Name
- The new File Name
- Flag determines whether file is to be be moved or copied
-
-
-
- [cnurse] 12/2/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes a Stream to the appropriate File Storage
-
- The Id of the File
- The Input Stream
- The name of the file
- The type of storage location
- A flag that dermines if the Input Stream should be closed.
-
-
-
- [cnurse] 04/27/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a File
-
- The File Name
- The Id of the Portal
- A flag that indicates whether the file cache should be cleared
- This method is called by the SynchonizeFolder method, when the file exists in the file system
- but not in the Database
-
-
- [cnurse] 12/2/2004 Created
- [cnurse] 04/26/2006 Updated to account for secure storage
- [cnurse] 04/07/2008 Made public
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a Folder
-
- Portal Settings for the Portal
- The Parent Folder Name
- The new Folder Name
-
-
-
- [cnurse] 12/4/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a Folder
-
- Portal Settings for the Portal
- The Parent Folder Name
- The new Folder Name
- The Storage Location
-
-
-
- [cnurse] 12/4/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a File to a Zip File
-
-
- [cnurse] 12/4/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Trys to copy a file in the file system
-
- The name of the source file
- The name of the destination file
-
- [cnurse] 06/27/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Copies a File
-
- The original File Name
- The new File Name
- The Portal Settings for the Portal/Host Account
-
-
-
- [cnurse] 12/2/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This checks to see if the folder is a protected type of folder
-
- String
- Boolean
-
-
-
- [cpaterra] 4/7/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Deletes file in areas with a high degree of concurrent file access (i.e. caching, logging)
- This solves file concurrency issues under heavy load.
-
- String
- Int16
- Int16
- Boolean
-
-
-
- [dcaron] 9/17/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Trys to delete a file from the file system
-
- The name of the file
-
- [cnurse] 04/26/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Deletes a file
-
- The File to delete
- The Portal Settings for the Portal/Host Account
-
-
-
- [Jon Henning] 11/1/2004 Created
- [cnurse] 12/6/2004 delete file from db
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Deletes a file
-
- The File to delete
- The Portal Settings for the Portal/Host Account
-
-
-
- [Jon Henning] 11/1/2004 Created
- [cnurse] 12/6/2004 delete file from db
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Deletes a folder
-
- The Id of the Portal
- The Directory Info object to delete
- The Name of the folder relative to the Root of the Portal
-
-
-
- [cnurse] 12/4/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Moved directly from FileManager code, probably should make extension lookup more generic
-
- File Location
-
-
-
- [Jon Henning] 11/1/2004 Created
- [Jon Henning] 1/4/2005 Fixed extension comparison, added content length header - DNN-386
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Streams a file to the output stream if the user has the proper permissions
-
- Portal Settings
- FileId identifying file in database
- Cache file in client browser - true/false
- Force Download File dialog box - true/false
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Streams a file to the output stream if the user has the proper permissions
-
- The Id of the Portal to which the file belongs
- FileId identifying file in database
- Cache file in client browser - true/false
- Force Download File dialog box - true/false
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- gets the content type based on the extension
-
- The extension
-
-
-
- [cnurse] 04/26/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets all the folders for a Portal
-
- The Id of the Portal
-
-
-
- [cnurse] 04/22/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets all the subFolders for a Parent
-
- The Id of the Portal
-
-
-
- [cnurse] 04/22/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Moves (Renames) a File
-
- The original File Name
- The new File Name
- The Portal Settings for the Portal/Host Account
-
-
-
- [cnurse] 12/2/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Assigns 1 or more attributes to a file
-
- File Location
- Pass in Attributes you wish to switch on (i.e. FileAttributes.Hidden + FileAttributes.ReadOnly)
-
-
-
- [Jon Henning] 11/1/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Sets a Folders Permissions to the Administrator Role
-
- The Id of the Portal
- The Id of the Folder
- The Id of the Administrator Role
- The folder's Relative Path
-
-
-
- [cnurse] 12/4/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Sets a Folders Permissions the same as the Folders parent folder
-
- The Id of the Portal
- The Id of the Folder
- The folder's Relative Path
-
-
-
- [cnurse] 08/01/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Sets a Folder Permission
-
- The Id of the Portal
- The Id of the Folder
- The Id of the Permission
- The Id of the Role
- The folder's Relative Path
-
-
-
- [cnurse] 01/12/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Unzips a File
-
- The zip File Name
- The folder where the file is extracted to
- The Portal Settings for the Portal/Host Account
-
-
-
-
- -----------------------------------------------------------------------------
-
-
-
- UploadFile pocesses a single file
-
- The folder wherr the file will be put
- The file to upload
-
-
- -----------------------------------------------------------------------------
-
- UploadFile pocesses a single file
-
- The folder wherr the file will be put
- The file to upload
-
-
-
-
-
- [cnurse] 16/9/2004 Updated for localization, Help and 508
- [Philip Beadle] 10/06/2004 Moved to Globals from WebUpload.ascx.vb so can be accessed by URLControl.ascx
- [cnurse] 04/26/2006 Updated for Secure Storage
- [sleupold] 08/14/2007 Added NewFileName
- [sdarkis] 10/19/2009 Calls CreateFile
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UploadFile pocesses a single file
-
- The folder where the file will be put
- The file name
- Content of the file
- Type of content, ie: text/html
-
-
-
-
-
- [cnurse] 16/9/2004 Updated for localization, Help and 508
- [Philip Beadle] 10/06/2004 Moved to Globals from WebUpload.ascx.vb so can be accessed by URLControl.ascx
- [cnurse] 04/26/2006 Updated for Secure Storage
- [sleupold] 08/14/2007 Added NewFileName
- [sdarkis] 10/19/2009 Creates a file from a string
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes file to response stream. Workaround offered by MS for large files
- http://support.microsoft.com/default.aspx?scid=kb;EN-US;812406
-
- FileName
-
-
-
- [Jon Henning] 1/4/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This handler handles requests for LinkClick.aspx, but only those specifc
- to file serving
-
- System.Web.HttpContext)
-
-
-
- [cpaterra] 4/19/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Primary Key ID of the current File, as represented within the Database table named "Files"
-
-
- This Integer Property is passed to the FileInfo Collection
-
-
- [DYNST] 2/1/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Class : FileInfo
-
- -----------------------------------------------------------------------------
-
- Represents the File object and holds the Properties of that object
-
-
-
-
- [DYNST] 2/1/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Class : FileController
-
- -----------------------------------------------------------------------------
-
- Business Class that provides access to the Database for the functions within the calling classes
- Instantiates the instance of the DataProvider and returns the object, if any
-
-
-
-
- [DYNST] 2/1/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the ControlPanel is Visible
-
- A Boolean
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the current Portal Settings
-
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the User mode of the Control Panel
-
- A Boolean
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a Module Permission
-
- The permission to add
- The Id of the role to add the permission for.
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds an Existing Module to a Pane
-
- The alignment for the Modue
- The Id of the existing module
- The id of the tab
- The pane to add the module to
- The relative position within the pane for the module
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Adds a New Module to a Pane
-
- The alignment for the Modue
- The Id of the DesktopModule
- The View Permission Type for the Module
- The Title for the resulting module
- The pane to add the module to
- The relative position within the pane for the module
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Builds a URL
-
- The friendly name of the Module
- The ID of the portal
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Sets the UserMode
-
- The userMode to set
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Sets the current Visible Mode
-
- A flag indicating whether the Control Panel should be visible
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Local ResourceFile for the Control Panel
-
- A String
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ControlPanel class defines a custom base class inherited by all
- ControlPanel controls.
-
-
-
-
- [cnurse] 01/11/2008 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated Language
-
- An Locale object
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated Language Pack
-
- An LanguagePackInfo object
-
- [cnurse] 05/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LanguagePackWriter class
-
-
-
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of AppCodeFiles that should be included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 02/12/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Path for the Package's app code files
-
- A String
-
- [cnurse] 02/12/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Assemblies that should be included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Path for the Package's assemblies
-
- A String
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Base Path for the Package
-
- A String
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of CleanUpFiles that should be included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 02/21/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Files that should be included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether a project file is found in the folder
-
- A String
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to include Assemblies
-
- A Boolean
-
- [cnurse] 02/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
-
- Gets and sets whether there are any errors in parsing legacy packages
-
-
-
-
-
- -----------------------------------------------------------------------------
-
- Gets the Logger
-
- An Logger object
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated Package
-
- An PackageInfo object
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Resources that should be included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a Dictionary of Scripts that should be included in the Package
-
- A Dictionary(Of String, InstallFile)
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a List of Versions that should be included in the Package
-
- A List(Of String)
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
-
- WriteManifest writes an existing manifest
-
- The name of the manifest file
- The manifest
- This overload takes a package manifest and writes it to a file
-
-
- WriteManifest writes a package manifest to an XmlWriter
-
- The XmlWriter
- The manifest
- This overload takes a package manifest and writes it to a Writer
-
-
- WriteManifest writes the manifest assoicated with this PackageWriter to a string
-
- A flag that indicates whether to return the package element
- as a fragment (True) or whether to add the outer dotnetnuke and packages elements (False)
- The manifest as a string
-
-
- -----------------------------------------------------------------------------
-
- The PackageWriter class
-
-
-
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The GetWriter method instantiates the relevant PackageWriter Installer
-
- The associated PackageInfo instance
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageWriterFactory is a factory class that is used to instantiate the
- appropriate Package Writer
-
-
-
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated Desktop Module
-
- A DesktopModuleInfo object
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ModulePackageWriter class
-
-
-
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs the FileComponentWriter
-
- The Base Path for the files
- A Dictionary of files
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("files")
-
- A String
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("File")
-
- A String
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("file")
-
- A String
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Logger
-
- A Logger
-
- [cnurse] 02/06/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Package
-
- A PackageInfo
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The WriteCustomManifest method writes the custom manifest items (that subclasses
- of FileComponentWriter may need)
-
- The Xmlwriter to use
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The FileComponentWriter class handles creating the manifest for File Component(s)
-
-
-
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs the SkinComponentWriter
-
- The name of the Skin
- The Base Path for the files
- A Dictionary of files
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("skinFiles")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("Skin")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("skinFile")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the SkinName Node ("skinName")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The WriteCustomManifest method writes the custom manifest items (that subclasses
- of FileComponentWriter may need)
-
- The Xmlwriter to use
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SkinComponentWriter class handles creating the manifest for Skin Component(s)
-
-
-
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SkinPackageWriter class
-
-
-
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ContainerPackageWriter class
-
-
-
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs the ContainerComponentWriter
-
- The name of the Container
- The Base Path for the files
- A Dictionary of files
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("containerFiles")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("Skin")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("containerFile")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the SkinName Node ("containerName")
-
- A String
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ContainerComponentWriter class handles creating the manifest for Container
- Component(s)
-
-
-
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("assemblies")
-
- A String
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("Assembly")
-
- A String
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("assembly")
-
- A String
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AssemblyComponentWriter class handles creating the manifest for Assembly
- Component(s)
-
-
-
-
- [cnurse] 02/01/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated Authentication System
-
- An AuthenticationInfo object
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationPackageWriter class
-
-
-
-
- [cnurse] 01/30/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets aflag that indicates whether the user or role has permission
-
- A Boolean
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the User's DisplayName
-
- A String
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Role ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Role Name
-
- A String
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the User ID
-
- An Integer
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the User Name
-
- A String
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillInternal fills the PermissionInfoBase from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : PermissionInfoBase
- -----------------------------------------------------------------------------
-
- PermissionInfoBase provides a base class for PermissionInfo classes
-
- All Permission calsses have a common set of properties
- - AllowAccess
- - RoleID
- - RoleName
- - UserID
- - Username
- - DisplayName
-
- and these are implemented in this base class
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : CompareTabPermissions
- -----------------------------------------------------------------------------
-
- CompareTabPermissions provides the a custom IComparer implementation for
- TabPermissionInfo objects
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : CompareModulePermissions
- -----------------------------------------------------------------------------
-
- CompareModulePermissions provides the a custom IComparer implementation for
- ModulePermissionInfo objects
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : DesktopModuleSupportedFeature
- -----------------------------------------------------------------------------
-
- The DesktopModuleSupportedFeature enum provides an enumeration of Supported
- Features
-
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : VisibilityState
- -----------------------------------------------------------------------------
-
- The VisibilityState enum provides an enumeration of the Visibility options
-
-
- [cnurse] 01/11/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
- Project : DotNetNuke
- Class : ModuleActionType
------------------------------------------------------------------------------
-
- Identifies common module action types
-
-
- Common action types can be specified in the CommandName attribute of the
- ModuleAction class
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Entities.Modules.Actions
- Class: ActionEventHandler
- -----------------------------------------------------------------------------
-
- The ActionEventHandler delegate defines a custom event handler for an Action
- Event.
-
-
- [cnurse] 01/12/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Constructs a new ObjectMappingInfo Object
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CacheKey gets the root value of the key used to identify the cached collection
- in the ASP.NET Cache.
-
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CacheByProperty gets and sets the property that is used to cache collections
- of the object. For example: Modules are cached by the "TabId" proeprty. Tabs
- are cached by the PortalId property.
-
- If empty, a collection of all the instances of the object is cached.
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CacheTimeOutMultiplier gets and sets the multiplier used to determine how long
- the cached collection should be cached. It is multiplied by the Performance
- Setting - which in turn can be modified by the Host Account.
-
- Defaults to 20.
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ColumnNames gets a dictionary of Database Column Names for the Object
-
-
- [cnurse] 12/02/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ObjectType gets and sets the type of the object
-
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- PrimaryKey gets and sets the property of the object that corresponds to the
- primary key in the database
-
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Properties gets a dictionary of Properties for the Object
-
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- TableName gets and sets the name of the database table that is used to
- persist the object.
-
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Common.Utilities
- Class: ObjectMappingInfo
- -----------------------------------------------------------------------------
-
- The ObjectMappingInfo class is a helper class that holds the mapping information
- for a particular type. This information is in two parts:
- - Information about the Database Table that the object is mapped to
- - Information about how the object is cached.
- For each object, when it is first accessed, reflection is used on the class and
- an instance of ObjectMappingInfo is created, which is cached for performance.
-
-
- [cnurse] 12/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CreateObjectFromReader creates an object of a specified type from the
- provided DataReader
-
- The type of the Object
- The IDataReader to use to fill the object
- A flag that indicates whether the DataReader should be closed
- The object (TObject)
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillDictionaryFromReader fills a dictionary of objects of a specified type
- from a DataReader.
-
- The type of the key
- The type of the value
- The key field for the object. This is used as
- the key in the Dictionary.
- The IDataReader to use to fill the objects
- The Dictionary to fill.
- A Dictionary of objects (T)
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillListFromReader fills a list of objects of a specified type
- from a DataReader
-
- The type of the business object
- The IDataReader to use to fill the objects
- The List to Fill
- A flag that indicates whether the DataReader should be closed
- A List of objects (TItem)
-
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillListFromReader fills a list of objects of a specified type
- from a DataReader
-
- The type of the business object
- The IDataReader to use to fill the objects
- The List to Fill
- A flag that indicates whether the DataReader should be closed
- A List of objects (TItem)
-
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillObjectFromReader fills an object from the provided DataReader. If the object
- implements the IHydratable interface it will use the object's IHydratable.Fill() method.
- Otherwise, it will use reflection to fill the object.
-
- The object to fill
- The DataReader
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- HydrateObject uses reflection to hydrate an object.
-
- The object to Hydrate
- The IDataReader that contains the columns of data for the object
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetCacheByProperty gets the name of the Property that the object is cached by.
- For most modules this would be the "ModuleID". In the core Tabs are cached
- by "PortalID" and Modules are cached by "TabID".
-
- The type of the business object
- The name of the Property
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetCacheTimeOutMultiplier gets the multiplier to use in the sliding cache
- expiration. This value is multiplier by the Host Performance setting, which
- in turn can be set by the Host Account.
-
- The type of the business object
- The timeout expiry multiplier
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetColumnName gets the name of the Database Column that maps to the property.
-
- The proeprty of the business object
- The name of the Database Column
-
- [cnurse] 12/02/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetObjectMapping gets an instance of the ObjectMappingInfo class for the type.
- This is cached using a high priority as reflection is expensive.
-
- The type of the business object
- An ObjectMappingInfo object representing the mapping for the object
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetPrimaryKey gets the Primary Key property
-
- The type of the business object
- The name of the Primary Key property
-
- [cnurse] 12/01/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetTableName gets the name of the Database Table that maps to the object.
-
- The type of the business object
- The name of the Database Table
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CloneObject clones an object
-
- The Object to Clone
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CreateObject creates a new object of Type TObject.
-
- The type of object to create.
- This overload does not initialise the object
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CreateObject creates a new object of Type TObject.
-
- The type of object to create.
- A flag that indicates whether to initialise the
- object.
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- CreateObject creates a new object.
-
- The type of object to create.
- A flag that indicates whether to initialise the
- object.
-
- [cnurse] 11/30/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillCollection fills a Collection of objects from a DataReader
-
- The Data Reader
- The type of the Object
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillCollection fills a Collection of objects from a DataReader
-
- The Data Reader
- The type of the Object
- Flag that indicates whether the Data Reader should be closed.
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillCollection fills a Collection of objects from a DataReader
-
- The Data Reader
- The type of the Object
- An IList to fill
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillCollection fills a Collection of objects from a DataReader
-
- The type of object
- The Data Reader
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillCollection fills a Collection of objects from a DataReader
-
- The type of object
- The List to fill
- The Data Reader
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillCollection fills a List of objects from a DataReader
-
- The type of the Object
- The List to fill
- The Data Reader
- A flag that indicates whether the DataReader should be closed
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Generic version of FillCollection fills a List custom business object of a specified type
- from the supplied DataReader
-
- The IDataReader to use to fill the object
- The type of the Object
- The total No of records
- A List of custom business objects
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Generic version of FillCollection fills a List custom business object of a specified type
- from the supplied DataReader
-
- The type of the business object
- The IDataReader to use to fill the object
- A List of custom business objects
-
-
- [cnurse] 10/10/2005 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillDictionary fills a Dictionary of objects from a DataReader
-
- The value for the Dictionary Item
- The Data Reader
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillDictionary fills a Dictionary of objects from a DataReader
-
- The value for the Dictionary Item
- The Dictionary to fill
- The Data Reader
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillDictionary fills a Dictionary of objects from a DataReader
-
- The key for the Dictionary
- The value for the Dictionary Item
- The key field used for the Key
- The Data Reader
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillDictionary fills a Dictionary of objects from a DataReader
-
- The key for the Dictionary
- The value for the Dictionary Item
- The key field used for the Key
- The Dictionary to fill
- The Data Reader
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillObject fills an object from a DataReader
-
- The type of the object
- The Data Reader
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillObject fills an object from a DataReader
-
- The type of the object
- The Data Reader
- A flag that indicates the reader should be closed
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillObject fills an object from a DataReader
-
- The Data Reader
- The type of the object
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillObject fills an object from a DataReader
-
- The Data Reader
- The type of the object
- A flag that indicates the reader should be closed
-
- [cnurse] 11/29/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillSortedList fills a SortedList of objects from a DataReader
-
- The key for the SortedList
- The value for the SortedList Item
- The key field used for the Key
- The Data Reader
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetCachedObject gets an object from the Cache
-
- The type of th object to fetch
- A CacheItemArgs object that provides parameters to manage the
- cache AND to fetch the item if the cache has expired
- A CacheItemExpiredCallback delegate that is used to repopulate
- the cache if the item has expired
-
- [cnurse] 01/13/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetProperties gets a Dictionary of the Properties for an object
-
- The type of the object
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetProperties gets a Dictionary of the Properties for an object
-
- The type of the object
-
- [cnurse] 01/17/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- InitializeObject initialises all the properties of an object to their
- Null Values.
-
- The object to Initialise
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- InitializeObject initialises all the properties of an object to their
- Null Values.
-
- The object to Initialise
- The type of the object
-
- [cnurse] 11/29/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SerializeObject serializes an Object
-
- The object to Initialise
- A filename for the resulting serialized xml
-
- [cnurse] 01/17/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SerializeObject serializes an Object
-
- The object to Initialise
- An XmlDocument to serialize to
-
- [cnurse] 01/17/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SerializeObject serializes an Object
-
- The object to Initialise
- A Stream to serialize to
-
- [cnurse] 01/17/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SerializeObject serializes an Object
-
- The object to Initialise
- A TextWriter to serialize to
-
- [cnurse] 01/17/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SerializeObject serializes an Object
-
- The object to Initialise
- An XmlWriter to serialize to
-
- [cnurse] 01/17/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Common.Utilities
- Class: CBO
- -----------------------------------------------------------------------------
-
- The CBO class generates objects.
-
-
- [cnurse] 12/01/2007 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- RenderEditMode renders the Edit mode of the control
-
- A HtmlTextWriter.
-
- [cnurse] 02/27/2006 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Services.Installer.Packages.WebControls
- Class: PackageTypeEditControl
- -----------------------------------------------------------------------------
-
- The PackageTypeEditControl control provides a standard UI component for editing
- package types.
-
-
- [cnurse] 01/25/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Services.Installer.Packages
- Class: PackageCreatedEventHandler
- -----------------------------------------------------------------------------
-
- The PackageCreatedEventHandler delegate defines a custom event handler for a
- PAckage Created Event.
-
-
- [cnurse] 01/23/2008 Created
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Builds a new PackageCreatedEventArgs
-
- The package associated with this event
-
-
- [cnurse] 01/23/2008 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets the Package associated with this event
-
-
- [cnurse] 01/23/2008 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace : DotNetNuke.Services.Installer.Packages
- Class : PackageCreatedEventArgs
------------------------------------------------------------------------------
-
- PackageCreatedEventArgs provides a custom EventArgs class for a
- Package Created Event.
-
-
- [cnurse] 01/23/2008 Created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Package ID
-
- An Integer
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Editor is in the Wizard
-
- An Boolean
-
- [cnurse] 08/26/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Used to Initialize the Control
-
-
- [cnurse] 02/21/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Used to Update the Package
-
-
- [cnurse] 02/21/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageEditorBase class provides a Base Classs for Package Editors
-
-
- [cnurse] 02/04/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LegacyUtil class is a Utility class that provides helper methods to transfer
- legacy packages to Cambrian's Universal Installer based system
-
-
-
-
- [cnurse] 01/23/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new PackageInstaller instance
-
- A PackageInfo instance
-
- [cnurse] 01/21/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- This Constructor creates a new PackageInstaller instance
-
- An InstallerInfo instance
- The manifest as a string
-
- [cnurse] 01/16/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets whether the Packages files are deleted when uninstalling the
- package
-
- A Boolean value
-
- [cnurse] 01/31/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Package is Valid
-
- A Boolean value
-
- [cnurse] 01/16/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CheckSecurity method checks whether the user has the appropriate security
-
-
- [cnurse] 09/04/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadComponents method reads the components node of the manifest file.
-
-
- [cnurse] 01/21/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ValidateVersion method checks whether the package is already installed
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method commits the package installation
-
-
- [cnurse] 08/01/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the components of the package
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file and parses it into components.
-
-
- [cnurse] 07/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method rolls back the package installation
-
-
- [cnurse] 07/31/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Uninstall method uninstalls the components of the package
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PackageInstaller class is an Installer for Packages
-
-
- [cnurse] 01/16/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteModule method deletes the Module from the data Store.
-
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
- In the case of Modules this is not neccessary
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the Module component
-
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file for the Module compoent.
-
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the component in the event
- that one of the other components fails
-
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the Module component
-
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ModuleInstaller installs Module Components to a DotNetNuke site
-
-
-
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("resourceFiles")
-
- A String
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("resourceFile")
-
- A String
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Manifest
-
- A String
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CommitFile method commits a single file.
-
- The InstallFile to commit
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteFile method deletes a single assembly.
-
- The InstallFile to delete
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The InstallFile method installs a single assembly.
-
- The InstallFile to install
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a flag that determines what type of file this installer supports
-
- The type of file being processed
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifestItem method reads a single node
-
- The XPathNavigator representing the node
- Flag that determines whether a check should be made
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The RollbackFile method rolls back the install of a single file.
-
- For new installs this removes the added file. For upgrades it restores the
- backup file created during install
- The InstallFile to commit
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ResourceFileInstaller installs Resource File Components (zips) to a DotNetNuke site
-
-
-
-
- [cnurse] 01/18/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("languageFiles")
-
- A String
-
- [cnurse] 01/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("languageFile")
-
- A String
-
- [cnurse] 01/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteLanguage method deletes the Language
- from the data Store.
-
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProcessFile method determines what to do with parsed "file" node
-
- The file represented by the node
- The XPathNavigator representing the node
-
- [cnurse] 08/07/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadCustomManifest method reads the custom manifest items
-
- The XPathNavigator representing the node
-
- [cnurse] 08/22/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
- In the case of Modules this is not neccessary
-
- [cnurse] 01/15/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the language component
-
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the component in the event
- that one of the other components fails
-
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the language component
-
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LanguageInstaller installs Language Packs to a DotNetNuke site
-
-
-
-
- [cnurse] 01/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new DesktopModulePermissionInfo
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs a new DesktopModulePermissionInfo
-
- A PermissionInfo object
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the DesktopModule Permission ID
-
- An Integer
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the PortalDesktopModule ID
-
- An Integer
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Compares if two DesktopModulePermissionInfo objects are equivalent/equal
-
- a DesktopModulePermissionObject
- true if the permissions being passed represents the same permission
- in the current object
-
-
- This function is needed to prevent adding duplicates to the DesktopModulePermissionCollection.
- DesktopModulePermissionCollection.Contains will use this method to check if a given permission
- is already included in the collection.
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a DesktopModulePermissionInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : DesktopModulePermissionInfo
- -----------------------------------------------------------------------------
-
- DesktopModulePermissionInfo provides the Entity Layer for DesktopModulePermissionInfo
- Permissions
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- ClearPermissionCache clears the DesktopModule Permission Cache
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- FillDesktopModulePermissionDictionary fills a Dictionary of DesktopModulePermissions from a
- dataReader
-
- The IDataReader
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModulePermissions gets a Dictionary of DesktopModulePermissionCollections by
- DesktopModule.
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModulePermissionsCallBack gets a Dictionary of DesktopModulePermissionCollections by
- DesktopModule from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddDesktopModulePermission adds a DesktopModule Permission to the Database
-
- The DesktopModule Permission to add
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteDesktopModulePermission deletes a DesktopModule Permission in the Database
-
- The ID of the DesktopModule Permission to delete
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteDesktopModulePermissionsByPortalDesktopModuleID deletes a DesktopModule's
- DesktopModule Permission in the Database
-
- The ID of the DesktopModule to delete
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteDesktopModulePermissionsByUserID deletes a user's DesktopModule Permission in the Database
-
- The user
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModulePermission gets a DesktopModule Permission from the Database
-
- The ID of the DesktopModule Permission
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetDesktopModulePermissions gets a DesktopModulePermissionCollection
-
- The ID of the DesktopModule
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- HasDesktopModulePermission checks whether the current user has a specific DesktopModule Permission
-
- The Permissions for the DesktopModule
- The Permission to check
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateDesktopModulePermission updates a DesktopModule Permission in the Database
-
- The DesktopModule Permission to update
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : DesktopModulePermissionController
- -----------------------------------------------------------------------------
-
- DesktopModulePermissionController provides the Business Layer for DesktopModule Permissions
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : DesktopModulePermissionCollection
- -----------------------------------------------------------------------------
-
- DesktopModulePermissionCollection provides the a custom collection for DesktopModulePermissionInfo
- objects
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : CompareDesktopModulePermissions
- -----------------------------------------------------------------------------
-
- CompareDesktopModulePermissions provides the a custom IComparer implementation for
- DesktopModulePermissionInfo objects
-
-
- [cnurse] 01/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Permissions Collection
-
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Id of the PortalDesktopModule
-
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the DesktopModulePermissions from the Data Store
-
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Parse the Permission Keys used to persist the Permissions in the ViewState
-
- A string array of settings
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Updates a Permission
-
- The permissions collection
- The user to add
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the permissions from the Database
-
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Load the ViewState
-
- The saved state
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Saves the ViewState
-
-
- [cnurse] 02/22/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- returns whether or not the derived grid supports Deny permissions
-
-
- [cnurse] 01/09/2006 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Class : SkinPackageInfo
-
- -----------------------------------------------------------------------------
-
- Handles the Business Object for Skins
-
-
-
-
- [cnurse] 02/04/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Class : SkinInfo
-
- -----------------------------------------------------------------------------
-
- Handles the Business Object for Skins
-
-
-
-
- [willhsc] 3/3/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SkinEventHandler delegate defines a custom event handler for a Skin
- Event.
-
-
- [cnurse] 05/19/2009 Created
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- SkinEventArgs provides a custom EventARgs class for Skin Events
-
-
-
- [cnurse] 05/19/2009 Created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- SkinEventType provides a custom enum for skin event types
-
-
-
- [cnurse] 05/19/2009 Created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.UI.Modules
- Class : ISettingsControl
- -----------------------------------------------------------------------------
-
- ISettingsControl provides a common Interface for Module Settings Controls
-
-
- [cnurse] 12/24/2007 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- LoadControl loads a control and returns a reference to the control
-
- The type of control to Load
- The parent Container Control
- The source for the control. This can either be a User Control (.ascx) or a compiled
- control.
- A Control of type T
-
- [cnurse] 12/05/2007 Created
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- ContainerEventType provides a custom enum for Container event types
-
-
-
- [cnurse] 05/19/2009 Created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ContainerEventHandler delegate defines a custom event handler for a Container
- Event.
-
-
- [cnurse] 05/19/2009 Created
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- ContainerEventArgs provides a custom EventARgs class for Container Events
-
-
-
- [cnurse] 05/20/2009 Created
-
------------------------------------------------------------------------------
-
-
-
- Returns an Empty String for all Properties
-
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to inlcude Common Words in the Search Index
-
- Defaults to False
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to inlcude Numbers in the Search Index
-
- Defaults to False
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the maximum Search Word length to index
-
- Defaults to 25
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the maximum Search Word length to index
-
- Defaults to 3
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SearchConfig class provides a configuration class for Search
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Initializes a new instance of the
- class containing the specified collection objects.
-
- A object
- which is wrapped by the collection.
- This overloaded constructor copies the s
- from the indicated array.
-
- [jbrinkman] 11/17/2004 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LocaleCollectionWrapper class provides a simple wrapper around a
- .
-
-
- The class
- implements a custom dictionary class which does not provide for simple databinding.
- This wrapper class exposes the individual objects of the underlying dictionary class
- thereby allowing for simple databinding to the colleciton of objects.
-
-
- [jbrinkman] 11/17/2004 Created
-
- -----------------------------------------------------------------------------
-
-
-
- The LocaleCollection class is a collection of Locale objects. It stores the supported locales.
-
-
- -----------------------------------------------------------------------------
-
- Enumeration that determines the type of Languages List
-
-
- [cnurse] 2/19/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs the LanguageComponentWriter
-
- A Dictionary of files
-
- [cnurse] 02/08/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs the LanguageComponentWriter
-
- A Dictionary of files
-
- [cnurse] 02/08/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("languageFiles")
-
- A String
-
- [cnurse] 02/08/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("CoreLanguage/ExtensionLanguage")
-
- A String
-
- [cnurse] 02/08/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("languageFile")
-
- A String
-
- [cnurse] 02/08/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The WriteCustomManifest method writes the custom manifest items
-
- The Xmlwriter to use
-
- [cnurse] 02/04/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LanguageComponentWriter class handles creating the manifest for Language
- Component(s)
-
-
-
-
- [cnurse] 02/08/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("scripts")
-
- A String
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("Script")
-
- A String
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("script")
-
- A String
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ScriptComponentWriter class handles creating the manifest for Script
- Component(s)
-
-
-
-
- [cnurse] 02/11/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs the ResourceFileComponentWriter
-
- The Base Path for the files
- A Dictionary of files
-
- [cnurse] 02/22/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("resourceFiles")
-
- A String
-
- [cnurse] 02/22/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("ResourceFile")
-
- A String
-
- [cnurse] 02/22/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("resourceFile")
-
- A String
-
- [cnurse] 02/22/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ResourceFileComponentWriter class handles creating the manifest for Resource
- File Component(s)
-
-
-
-
- [cnurse] 02/22/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the associated SkinControl
-
- A SkinControlInfo object
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SkinControlPackageWriter class
-
-
-
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProviderPackageWriter class
-
-
-
-
- [cnurse] 05/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LibraryPackageWriter class
-
-
-
-
- [cnurse] 11/07/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("widgetFiles")
-
- A String
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("widgetFiles")
-
- A String
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Component Type ("Widget")
-
- A String
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The WidgetComponentWriter class handles creating the manifest for Widget Component(s)
-
-
-
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The WidgetPackageWriter class
-
-
-
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Constructs the ContainerComponentWriter
-
- A Dictionary of files
-
- [cnurse] 02/21/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The CleanupComponentWriter class handles creating the manifest for Cleanup
- Component(s)
-
-
-
-
- [cnurse] 02/21/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The DeleteSkinControl method deletes the SkinControl from the data Store.
-
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Commit method finalises the Install and commits any pending changes.
-
- In the case of Modules this is not neccessary
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Install method installs the Module component
-
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file for the SkinControl compoent.
-
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The Rollback method undoes the installation of the component in the event
- that one of the other components fails
-
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UnInstall method uninstalls the SkinControl component
-
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The SkinControlInstaller installs SkinControl (SkinObject) Components to a DotNetNuke site
-
-
-
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 03/28/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ProviderInstaller installs Provider Components to a DotNetNuke site
-
-
-
-
- [cnurse] 05/29/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Collection Node ("widgetFiles")
-
- A String
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the name of the Item Node ("widgetFiles")
-
- A String
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PhysicalBasePath for the widget files
-
- A String
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The WidgetInstaller installs Widget Components to a DotNetNuke site
-
-
-
-
- [cnurse] 11/24/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets a list of allowable file extensions (in addition to the Host's List)
-
- A String
-
- [cnurse] 01/05/2009 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The ReadManifest method reads the manifest file for the Authentication compoent.
-
-
- [cnurse] 07/25/2007 created
-
- -----------------------------------------------------------------------------
-
-
-
- Initializes a new instance of the class.
-
- The error message to display.
-
- -----------------------------------------------------------------------------
-
- The InvalidDependency signifies a dependency that is always invalid,
- taking the place of dependencies that could not be created
-
-
-
-
- [bdukes] 03/03/2009 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The PortalSettings Constructor encapsulates all of the logic
- necessary to obtain configuration settings necessary to render
- a Portal Tab view for a given request.
-
-
-
- The current tab
- The current portal
-
- [cnurse] 10/21/2004 documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Default Module Id
-
- Defaults to Null.NullInteger
-
- [cnurse] 05/02/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Default Tab Id
-
- Defaults to Null.NullInteger
-
- [cnurse] 05/02/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether Browser Language Detection is Enabled
-
- Defaults to True
-
- [cnurse] 02/19/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to use the Language in the Url
-
- Defaults to True
-
- [cnurse] 02/19/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Skin Widgets are enabled/supported
-
- Defaults to True
-
- [cnurse] 07/03/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Inline Editor is enabled
-
- Defaults to True
-
- [cnurse] 08/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to inlcude Common Words in the Search Index
-
- Defaults to False
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to inlcude Numbers in the Search Index
-
- Defaults to False
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the maximum Search Word length to index
-
- Defaults to 25
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the maximum Search Word length to index
-
- Defaults to 3
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The GetPortalSettings method builds the site Settings
-
-
-
- The current tabs id
- The Portal object
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The VerifyPortalTab method verifies that the TabId/PortalId combination
- is allowed and returns default/home tab ids if not
-
-
-
-
- The Portal's id
- The current tab's id
-
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- PortalSettings Class
-
- This class encapsulates all of the settings for the Portal, as well
- as the configuration settings required to execute the current tab
- view within the portal.
-
-
-
-
- [cnurse] 10/21/2004 documented
- [cnurse] 10/21/2004 added GetTabModuleSettings
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetSecureHostSettingsDictionaryCallBack gets a Dictionary of Security Host
- Settings from the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 07/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the AutoAccountUnlockDuration
-
- Defaults to 10
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the AuthenticatedCacheability
-
- Defaults to HttpCacheability.ServerAndNoCache
-
- [cnurse] 03/05/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Upgrade Indicator is enabled
-
- Defaults to True
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Control Panel
-
- Defaults to glbDefaultControlPanel constant
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Default Admin Container
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Default Admin Skin
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Default Doc Type
-
-
- [cnurse] 07/14/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Default Portal Container
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Default Portal Skin
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Demo Period for new portals
-
- Defaults to -1
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether demo signups are enabled
-
- Defaults to False
-
- [cnurse] 04/14/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to dislpay the beta notice
-
- Defaults to True
-
- [cnurse] 05/19/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to dislpay the copyright
-
- Defaults to True
-
- [cnurse] 03/05/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether AJAX is Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether File AutoSync is Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether content localization has been enabled
-
- Defaults to False
-
- [cathal] 20/10/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the content locale used by dynamic localisation
-
- If content localization is not enabled, defaults to portal default language
-
- [cathal] 20/10/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether Browser Language Detection is Enabled
-
- Defaults to True
-
- [cnurse] 02/19/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether Module Online Help is Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Request Filters are Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to use the Language in the Url
-
- Defaults to True
-
- [cnurse] 02/19/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether Users Online are Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether SSL is Enabled for SMTP
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Event Log Buffer is Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Allowed File Extensions
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the GUID
-
-
- [cnurse] 12/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Help URL
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Host Currency
-
- Defaults to USD
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Host Email
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Host Fee
-
- Defaults to 0
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Host Portal's PortalId
-
- Defaults to Null.NullInteger
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Host Space
-
- Defaults to 0
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Host Title
-
-
- [cnurse] 12/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Host URL
-
-
- [cnurse] 04/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the HttpCompression Algorithm
-
- Defaults to Null.NullInteger(None)
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Module Caching method
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Page Caching method
-
-
- [jbrinkman] 11/17/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Page Quota
-
- Defaults to 0
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PageState Persister
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Password Expiry
-
- Defaults to 0
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Password Expiry Reminder window
-
- Defaults to 7 (1 week)
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Payment Processor
-
-
- [cnurse] 04/14/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the PerformanceSettings
-
- Defaults to PerformanceSettings.ModerateCaching
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Payment Processor Password
-
-
- [cnurse] 04/14/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Payment Processor User Id
-
-
- [cnurse] 04/14/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Proxy Server Password
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Proxy Server Port
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Proxy Server
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Proxy Server UserName
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to use the remember me checkbox
-
- Defaults to False
-
- [cnurse] 04/14/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Scheduler Mode
-
- Defaults to SchedulerMode.TIMER_METHOD
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to inlcude Common Words in the Search Index
-
- Defaults to False
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether to inlcude Numbers in the Search Index
-
- Defaults to False
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the maximum Search Word length to index
-
- Defaults to 25
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the maximum Search Word length to index
-
- Defaults to 3
-
- [cnurse] 03/10/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Site Log Buffer size
-
- Defaults to 1
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Site Log History
-
- Defaults to -1
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the Site Log Storage location
-
- Defaults to "D"
-
- [cnurse] 03/05/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the SMTP Authentication
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the SMTP Password
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the SMTP Server
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the SMTP Username
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether Exceptions are rethrown
-
- Defaults to False
-
- [cnurse] 07/24/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether Friendly Urls is Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether Custom Error Messages is Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the User Quota
-
- Defaults to 0
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the window to use in minutes when determining if the user is online
-
- Defaults to 15
-
- [cnurse] 01/29/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the WebRequest Timeout value
-
- Defaults to 10000
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets whether the Whitespace Filter is Enabled
-
- Defaults to False
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
-
- Gets whether to use the minified or debug version of the jQuery scripts
-
- Defaults to False
-
- [jbrinkman] 09/30/2008 Created
-
-
-
- Gets whether to use a hosted version of the jQuery script file
-
- Defaults to False
-
- [jbrinkman] 09/30/2008 Created
-
-
-
- Gets the Url for a hosted version of jQuery
-
- Defaults to the DefaultHostedUrl constant in the jQuery class.
- The framework will default to the latest released 1.x version hosted on Google.
-
-
- [jbrinkman] 09/30/2008 Created
-
-
- -----------------------------------------------------------------------------
-
- GetHostSetting gets a single Host Setting
-
- The Setting key
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetHostSettingDictionary gets a Dictionary of Host Settings from the cache or
- from the the Database.
-
-
- [cnurse] 07/15/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetHostSetting gets a single Secure Host Setting
-
- The Setting key
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetSecureHostSettingDictionary gets a Dictionary of SecureHost Settings from the cache or
- from the the Database.
-
-
- [cnurse] 01/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- All properties Constructor.
-
- The user being authenticated.
- The user token
- The login status.
- The type of Authentication
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a flag that determines whether the User was authenticated
-
-
- [cnurse] 07/11/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Authentication Type
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a flag that determines whether the user should be automatically registered
-
-
- [cnurse] 07/16/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Login Status
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Message
-
-
- [cnurse] 07/11/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Profile
-
-
- [cnurse] 07/16/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the User
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the UserToken (the userid or authenticated id)
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The UserAuthenticatedEventArgs class provides a custom EventArgs object for the
- UserAuthenticated event
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The LogOffHandler class provides a replacement for the LogOff page
-
-
- [cnurse] 10/26/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Type of Authentication associated with this control
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationLogoffBase class provides a base class for Authentiication
- Logoff controls
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationConfigBase class provides base configuration class for the
- Authentication providers
-
-
- [cnurse] 07/16/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationConfig class providesa configuration class for the DNN
- Authentication provider
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Type of Authentication associated with this control
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets whether the control is Enabled
-
- This property must be overriden in the inherited class
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the IP address associated with the request
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Type of Authentication associated with this control
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationLoginBase class provides a bas class for Authentiication
- Login controls
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and Sets the Type of Authentication associated with this control
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateSettings updates the settings in the Data Store
-
- This method must be overriden in the inherited class
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationSettingsBase class provides a base class for Authentiication
- Settings controls
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddAuthentication adds a new Authentication System to the Data Store.
-
- The new Authentication System to add
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- AddUserAuthentication adds a new UserAuthentication to the User.
-
- The new Authentication System to add
- The authentication type
- The authentication token
-
- [cnurse] 07/12/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetAuthenticationService fetches a single Authentication Systems
-
- The ID of the Authentication System
- An AuthenticationInfo object
-
- [cnurse] 07/31/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetAuthenticationServiceByPackageID fetches a single Authentication System
-
- The id of the Package
- An AuthenticationInfo object
-
- [cnurse] 07/31/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetAuthenticationServiceByType fetches a single Authentication Systems
-
- The type of the Authentication System
- An AuthenticationInfo object
-
- [cnurse] 07/31/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetAuthenticationServices fetches a list of all the Authentication Systems
- installed in the system
-
- A List of AuthenticationInfo objects
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetAuthenticationType fetches the authentication method used by the currently logged on user
-
- An AuthenticationInfo object
-
- [cnurse] 07/23/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetEnabledAuthenticationServices fetches a list of all the Authentication Systems
- installed in the system that have been enabled by the Host user
-
- A List of AuthenticationInfo objects
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetLogoffRedirectURL fetches the url to redirect too after logoff
-
- A PortalSettings object
- The current Request
- The Url
-
- [cnurse] 08/15/2007 Created
- [cnurse] 02/28/2008 DNN-6881 Logoff redirect
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SetAuthenticationType sets the authentication method used by the currently logged on user
-
- The Authentication type
-
- [cnurse] 07/23/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- UpdateAuthentication updates an existing Authentication System in the Data Store.
-
- The new Authentication System to update
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- The AuthenticationController class provides the Business Layer for the
- Authentication Systems.
-
-
- [cnurse] 07/10/2007 Created
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- The SecurityAccessLevel enum is used to determine which level of access rights
- to assign to a specific module or module action.
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModulePermissions gets a Dictionary of ModulePermissionCollections by
- Module.
-
- The ID of the tab
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModulePermissionsCallBack gets a Dictionary of ModulePermissionCollections by
- Module from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetTabPermissions gets a Dictionary of TabPermissionCollections by
- Tab.
-
- The ID of the portal
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetTabPermissionsCallBack gets a Dictionary of TabPermissionCollections by
- Tab from the the Database.
-
- The CacheItemArgs object that contains the parameters
- needed for the database call
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveFolderPermissions updates a Folder's permissions
-
- The Folder to update
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteModulePermissionsByUser deletes a user's Module Permission in the Database
-
- The user
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetModulePermissions gets a ModulePermissionCollection
-
- The ID of the module
- The ID of the tab
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- HasModulePermission checks whether the current user has a specific Module Permission
-
- The Permissions for the Module
- The Permission to check
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveModulePermissions updates a Module's permissions
-
- The Module to update
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteTabPermissionsByUser deletes a user's Tab Permissions in the Database
-
- The user
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetTabPermissions gets a TabPermissionCollection
-
- The ID of the tab
- The ID of the portal
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- HasTabPermission checks whether the current user has a specific Tab Permission
-
- The Permissions for the Tab
- The Permission to check
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveTabPermissions saves a Tab's permissions
-
- The Tab to update
-
- [cnurse] 04/15/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Security.Permissions
- Class : CompareTabPermissions
- -----------------------------------------------------------------------------
-
- CompareTabPermissions provides the a custom IComparer implementation for
- TabPermissionInfo objects
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
-
- Returns the default URL for a hosted version of the jQuery script
-
-
- Google hosts versions of many popular javascript libraries on their CDN.
- Using the hosted version increases the likelihood that the file is already
- cached in the users browser.
-
-
-
- Checks whether the jQuery core script file exists locally.
-
-
- This property checks for both the minified version and the full uncompressed version of jQuery.
- These files should exist in the /Resources/Shared/Scripts/jquery directory.
-
-
-
- Gets the HostSetting to determine if we should use the standard jQuery script or the minified jQuery script.
-
-
-
- This is a simple wrapper around the Host.jQueryDebug property
-
-
- Gets the HostSetting to determine if we should use a hosted version of the jQuery script.
-
-
-
- This is a simple wrapper around the Host.jQueryHosted property
-
-
- Gets the HostSetting for the URL of the hosted version of the jQuery script.
-
-
-
- This is a simple wrapper around the Host.jQueryUrl property
-
-
- Gets the version string for the local jQuery script
-
-
-
-
- This only evaluates the version in the full jQuery file and assumes that the minified script
- is the same version as the full script.
-
-
-
- Represents the collection of Tabs for a portal
-
-
-
------------------------------------------------------------------------------
- Project : DotNetNuke
- Class : TabMoveType
------------------------------------------------------------------------------
-
- Identifies common tab move types
-
-
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the SkinControl ID
-
- An Integer
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the ID of the Package for this Desktop Module
-
- An Integer
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a SkinControlInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets an XmlSchema for the SkinControlInfo
-
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Reads a SkinControlInfo from an XmlReader
-
- The XmlReader to use
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Writes a SkinControlInfo to an XmlWriter
-
- The XmlWriter to use
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : SkinControlInfo
- -----------------------------------------------------------------------------
-
- SkinControlInfo provides the Entity Layer for Skin Controls (SkinObjects)
-
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- DeleteSkinControl deletes a Skin Control in the database
-
- The Skin Control to delete
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetSkinControl gets a single Skin Control from the database
-
- The ID of the SkinControl
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetSkinControlByPackageID gets a single Skin Control from the database
-
- The ID of the Package
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetSkinControlByKey gets a single Skin Control from the database
-
- The key of the Control
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- GetSkinControls gets all the Skin Controls from the database
-
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- SaveSkinControl updates a Skin Control in the database
-
- The Skin Control to save
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : ModuleControlController
- -----------------------------------------------------------------------------
-
- ModuleControlController provides the Business Layer for Module Controls
-
-
- [cnurse] 01/14/2008 Documented
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Control Key
-
- A String
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Control Source
-
- A String
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets a flag that determines whether the control support the AJAX
- Update Panel
-
- A Boolean
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a ControlInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities.Modules
- Class : ControlInfo
- -----------------------------------------------------------------------------
-
- ControlInfo provides a base class for Module Controls and SkinControls
-
-
- [cnurse] 03/28/2008 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a ServerInfo from a Data Reader
-
- The Data Reader to use
-
- [cnurse] 03/25/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets and sets the Key ID
-
- An Integer
-
- [cnurse] 03/25/2009 Created
-
- -----------------------------------------------------------------------------
-
-
-
- This class manages the Server Information for the site
-
-
- -----------------------------------------------------------------------------
-
- Gets the CreatedByUserID
-
- An Integer
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the CreatedOnDate
-
- A DateTime
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the LastModifiedByUserID
-
- An Integer
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the LastModifiedOnDate
-
- A DateTime
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the UserInfo object associated with this user
-
- The PortalID associated with the desired user
- A UserInfo object
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Gets the UserInfo object associated with this user
-
- The PortalID associated with the desired user
- A UserInfo object
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
-
- Fills a BaseEntityInfo from a Data Reader
-
- The Data Reader to use
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
-
- method used by cbo to fill readonly properties ignored by HydrateObject reflection
-
- the data reader to use
-
-
- -----------------------------------------------------------------------------
- Project : DotNetNuke
- Namespace: DotNetNuke.Entities
- Class : BaseEntityInfo
- -----------------------------------------------------------------------------
-
- BaseEntityInfo provides auditing fields for Core tables.
-
-
- [jlucarino] 02/20/2009 Created
-
- -----------------------------------------------------------------------------
-
-
-
- Initializes a new instance of the SimpleContainer class.
-
-
-
- Initializes a new instance of the SimpleContainer class.
-
-
-
-
- Initializes a new instance of the InstanceComponentBuilder class.
-
-
-
-
-
- Initializes a new instance of the TransientComponentBuilder class.
-
- The name of the component
- The type of the component
-
-
- Initializes a new instance of the SingletonComponentBuilder class.
-
- The name of the component
- The type of the component
-
-
- Initializes a new instance of the ComponentType class.
-
- The base type of Components of this ComponentType
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Common.Utilities
- Class: CacheItemExpiredCallback
- -----------------------------------------------------------------------------
-
- The CacheItemExpiredCallback delegate defines a callback method that notifies
- the application when a CacheItem is Expired (when an attempt is made to get the item)
-
-
- [cnurse] 01/12/2008 created
-
- -----------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Constructs a new CacheItemArgs Object
-
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Constructs a new CacheItemArgs Object
-
-
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Constructs a new CacheItemArgs Object
-
-
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Constructs a new CacheItemArgs Object
-
-
-
-
-
- [cnurse] 07/15/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Constructs a new CacheItemArgs Object
-
-
-
-
-
- [cnurse] 07/14/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets and sets the Cache Item's CacheItemRemovedCallback delegate
-
-
- [cnurse] 01/13/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets and sets the Cache Item's CacheDependency
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets the Cache Item's Key
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets the Cache Item's priority (defaults to Default)
-
- Note: DotNetNuke currently doesn't support the ASP.NET Cache's
- ItemPriority, but this is included for possible future use.
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets the Cache Item's Timeout
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets the Cache Item's Parameter List
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
------------------------------------------------------------------------------
-
- Gets the Cache Item's Parameter Array
-
-
- [cnurse] 01/12/2008 created
-
------------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Project: DotNetNuke
- Namespace: DotNetNuke.Common.Utilities
- Class: CacheItemArgs
- -----------------------------------------------------------------------------
-
- The CacheItemArgs class provides an EventArgs implementation for the
- CacheItemExpiredCallback delegate
-
-
- [cnurse] 01/12/2008 created
-
- -----------------------------------------------------------------------------
-
-
- -----------------------------------------------------------------------------
- Namespace: DotNetNuke.Application
- Project: DotNetNuke
- Module: Application
- -----------------------------------------------------------------------------
-
- The Application class contains properties that describe the Application.
-
-
-
-
- [cnurse] 09/10/2009 created
-
- -----------------------------------------------------------------------------
-
-
-
-
\ No newline at end of file
diff --git a/Source/References/Framework/Engage.Dnn.Framework.XML b/Source/References/Framework/Engage.Dnn.Framework.XML
new file mode 100644
index 0000000..e8f2e38
--- /dev/null
+++ b/Source/References/Framework/Engage.Dnn.Framework.XML
@@ -0,0 +1,3758 @@
+
+
+
+ Engage.Dnn.Framework
+
+
+
+
+ Marker for classes that are supported by Engage: Commerce
+
+
+
+
+ Gets or sets the id.
+
+ The id of the sellable item.
+
+
+
+ Gets or sets the product GUID. This is used to uniquely identify a product since the id isn't good enough.
+
+ The product GUID.
+
+
+
+ Gets or sets the name or title that is used to generally refer to the item.
+
+ The name of the item.
+
+
+
+ Gets the description of the item.
+
+ The description of the item.
+
+
+
+ Gets or sets the product number
+
+ The number or code.
+
+
+
+ Gets the created date of the item.
+
+ The created date.
+
+
+
+ Gets the thumbnail image for a given item.
+
+ The thumbnail.
+
+
+
+ Represents the ways to get products
+
+
+
+
+ Gets the paged list of sellable items.
+
+ The portal id.
+ Size of the page.
+ Index of the page.
+ The total number of class members.
+ A sequence of class members
+
+
+
+ Interface marker
+
+
+
+
+ Processes the commerce tags.
+
+ The container.
+ The tag to parse.
+ The template item.
+ The resource file.
+ The tab id.
+ The module id.
+
+ True if the tag can be parsed by the commerce implementation.
+
+
+
+
+ Can be used as name and value pairs for list control objects.
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Initializes a new instance of the class.
+
+ The display member.
+ The value member.
+
+
+
+ Gets or sets the display member.
+
+ The display member.
+
+
+
+ Gets or sets the value member.
+
+ The value member.
+
+
+
+ An implementation for use when not in the context of an actual control
+
+
+
+
+ The common functionality of all module controls (i.e. both and ) in Engage modules.
+
+
+
+
+ Gets the name of this module's desktop module record in DNN.
+
+ The name of this module's desktop module record in DNN.
+
+
+
+ Gets the module configuration.
+
+ The module configuration.
+
+
+
+ Initializes a new instance of the class.
+
+ Settings prefix.
+ Module configuration.
+
+
+
+ Gets the name of the module's desktop module record in DNN.
+
+ The name of the module's desktop module record in DNN.
+
+
+
+ Gets the module configuration.
+
+ The module configuration.
+
+
+ Represents the actions that can be taken through the view
+ The type of the model.
+
+
+
+ This method is used to process tags that aren't already handled by the ProcessCommonTags in this project or handled higher up
+ in the Engage.Dnn.Framework. See documentation for types of tokens already handled by the Framework.
+
+ The container to place the control.
+ The tag to parse.
+ The template item.
+ The resource file.
+ A true if the tag was handled by this process.
+
+
+
+ The base for license providers
+
+
+
+
+ Initializes a new instance of the class.
+
+ The product key for the module/product.
+
+
+
+ Displays a message indicating that the license for this module has been determined to be invalid.
+
+ The control on which to show the message.
+
+
+
+ Determines whether this instance represents a valid license.
+
+ The control requesting license validation.
+
+ true if this instance is valid; otherwise, false.
+
+
+
+
+ Gets the message to display when the license evaluates as invalid.
+
+ The heading, message, and message type to display
+
+
+
+ Determines whether this instance represents a valid license.
+
+ The control requesting license validation.
+
+ true if this instance is valid; otherwise, false.
+
+
+
+
+ Gets the license key for this module/product.
+
+ The product license key.
+
+
+ The parts of a message to display
+
+
+
+ Initializes a new instance of the struct.
+
+ The heading of the message.
+ The text of the message itself.
+ The type of message.
+
+
+
+ Implements the == operator.
+
+ The left side of the operator.
+ The right side of the operator.
+ Whether equals .
+
+
+
+ Implements the != operator.
+
+ The left side of the operator.
+ The right side of the operator.
+ Whether is unequal to .
+
+
+ Determines whether the specified is equal to this instance.
+ The to compare with this instance.
+ true if the specified is equal to this instance; otherwise, false.
+
+
+
+ Determines whether the specified is equal to this instance.
+
+ The to compare with this instance.
+
+ true if the specified is equal to this instance; otherwise, false.
+
+
+
+
+ Returns a hash code for this instance.
+
+
+ A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
+
+
+
+
+ Gets the heading of the message.
+
+ The heading of the message.
+
+
+
+ Gets the message text.
+
+ The text of the message itself.
+
+
+
+ Gets the type of the message.
+
+ The type of message.
+
+
+
+ The base for a license provider that connects to a remote web service to authenticate the license
+
+
+
+
+ used to authenticate with the Engage licensing server.
+
+
+
+
+ The licenses retrieved from the server for each module
+
+
+
+
+ Initializes a new instance of the class.
+
+ The license key for the module for which this license provider is to be used
+
+
+
+ Determines whether the site has a valid license for this module.
+
+ The control being validated.
+ The site's GUID.
+ The portal's name.
+
+ true if the site has a valid license for this module; otherwise, false.
+
+
+
+
+ Determines whether this instance represents a valid license.
+
+ The control requesting license validation.
+
+ true if this instance is valid; otherwise, false.
+
+
+
+
+ Gets a license for an instance of a DNN module, when given a context and whether the denial of a license throws an exception.
+
+ A control that is requesting the license.
+ true if a should be thrown when the component cannot be granted a license; otherwise, false.
+
+ A valid .
+
+ This module is not licensed. Not need to call this service.
+
+
+ Determines whether a given module is correctly licensed for a specific server.
+
+
+ The span of time for which the module can go un-validated
+
+
+
+ Initializes a new instance of the class.
+
+ The license key for the module for which this license provider is to be used
+
+
+
+ Gets the message to display when the license evaluates as invalid.
+
+
+ The heading, message, and message type to display
+
+
+
+
+ Determines whether the site has a valid license for this module.
+
+ The control being validated.
+ The site's GUID.
+ The portal's name.
+
+ true if the site has a valid license for this module; otherwise, false.
+
+ License file was not found
+ Unable to validate license for more than three days
+
+
+
+ Gets the full physical path to the license file.
+
+ The control being validated.
+ The full physical path to the license file.
+
+
+
+ Handles exceptions from the web service call.
+
+ The control being validated.
+ The full physical path to the license file.
+ The exception to log.
+ Whether to count this as a valid license
+ Unable to validate license for more than three days
+
+
+
+ Determines whether the license file exists.
+
+ The full physical path to the license file.
+
+ true if the license file exists; otherwise, false.
+
+
+
+
+ Determines whether the license file has been updated within the .
+
+ The full physical path to the license file.
+
+ true if the license file has been updated within the ; otherwise, false.
+
+
+
+
+ Updates the content of the license file with the given date.
+
+ The full physical path to the license file.
+ The date to which the license should be updated.
+
+
+ Functionality for setting and retrieving settings
+ The type of the values this setting can hold
+
+
+ The controller to use when getting and saving module and tab-module settings
+
+
+ The controller to use when getting and saving tab settings
+
+
+ Initializes a new instance of the class.
+ Name of the setting key.
+ The scope of the setting.
+ The default value for this setting.
+
+
+
+ Sets this setting for the specified to the specified .
+ Properly converts to its representation for storage in the database.
+
+ Type of the given
+ A module control to which this setting applies.
+ The new value of the setting.
+
+
+
+ Sets this setting for the specified to the specified .
+ Properly converts to its representation for storage in the database.
+
+ Type of the given
+ A module control to which this setting applies.
+ The new value of the setting.
+
+
+
+ Sets this setting to the specified .
+ Properly converts to its representation for storage in the database.
+
+ Type of the given
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The new value of the setting.
+
+
+
+ Sets this setting to the specified .
+ Properly converts to its representation for storage in the database.
+
+ Type of the given
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The new value of the setting.
+
+
+
+ Sets this setting for the specified to the specified .
+ Properly converts to its representation for storage in the database.
+
+ Type of the given
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The new value of the setting.
+ This instance's property was not set to a valid value
+
+
+ Sets this setting for the specified to the specified .
+ A module control to which this setting applies.
+ The new value of the setting.
+
+
+ Sets this setting to the specified .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The new value of the setting.
+
+
+ Sets this setting to the specified .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The new value of the setting.
+
+
+ Sets this setting for the specified to the specified .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The new value of the setting.
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting for the given as a .
+ A module control instance to which this setting applies.
+ The value of this setting for the given
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+ The value of this setting
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+ The value of this setting
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting for the given as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+ The value of this setting for the given
+ This instance's property was not set to a valid value
+
+
+ Determines whether this setting has a value for the given .
+ A module control instance to which this setting applies.
+ true if the setting defined; otherwise, false.
+
+
+ Determines whether this setting has a value.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ true if the setting defined; otherwise, false.
+ This instance's property was not set to a valid value
+
+
+ Determines whether this setting has a value.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ true if the setting defined; otherwise, false.
+ This instance's property was not set to a valid value
+
+
+ Determines whether this setting has a value for the given .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ true if the setting defined; otherwise, false.
+ This instance's property was not set to a valid value
+
+
+
+ Gets the value of this setting for the given as an of ,
+ or if the setting hasn't been set or isn't an of .
+
+ The type of the to which the value should be converted.
+ A module control instance to which this setting applies.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a ,
+ or null if is not a .
+
+
+
+ Gets the value of this setting as an of .
+ The type of the to which the value should be converted.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as an of .
+ The type of the to which the value should be converted.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as an of .
+ The type of the to which the value should be converted.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as an of .
+ The type of the to which the value should be converted.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting for the given as an of .
+ The type of the to which the value should be converted.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+ must be an type
+
+
+ Gets the value of this setting for the given as an of .
+ The type of the to which the value should be converted.
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+ must be an type
+
+
+
+ Gets the value of this setting for the given as an ,
+ or if the setting hasn't been set or isn't an .
+
+ A module control instance to which this setting applies.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to an ,
+ or null if is not an .
+
+
+
+ Gets the value of this setting as an .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to an
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as an .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to an
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as an .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to an
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as an .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to an
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting for the given as an .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to an
+
+
+
+ Gets the value of this setting for the given as an .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to an
+
+
+
+
+ Gets the value of this setting for the given as a ,
+ or if the setting hasn't been set or isn't an .
+
+ A module control instance to which this setting applies.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a ,
+ or null if is not a .
+
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting for the given as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+
+
+ Gets the value of this setting for the given as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+
+
+
+ Gets the value of this setting for the given as a ,
+ or if the setting hasn't been set or isn't an .
+
+ A module control instance to which this setting applies.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a ,
+ or null if is not a .
+
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting for the given as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+
+
+ Gets the value of this setting for the given as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+
+
+
+ Gets the value of this setting for the given as a ,
+ or if the setting hasn't been set or isn't an .
+
+ A module control instance to which this setting applies.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a ,
+ or null if is not a .
+
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The ID of the portal to which this setting applies (or null if it doesn't apply to a specific portal).
+ The ID of the tab to which this setting applies (or null if it doesn't apply to a specific tab).
+ The ID of the module to which this setting applies (or null if it doesn't apply to a specific module).
+ The ID of the tab-module to which this setting applied (or null if it doesn't apply to a specific tab-module).
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting
+ or if the value does not exist yet or cannot be converted to a
+
+ This instance's property was not set to a valid value
+
+
+ Gets the value of this setting for the given as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+
+
+ Gets the value of this setting for the given as a .
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+
+
+ Creates a module configuration with the given values.
+ The portal ID.
+ The tab ID.
+ The module ID.
+ The tab module ID.
+ A instance with those values set
+
+
+ Gets the given setting as a , or if the setting is not set.
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The setting or default as a
+
+
+
+ Converts the given to a ,
+ using to convert it to its representation
+ if is an .
+
+ The value to convert.
+ An invariant representation of
+
+
+ Formats this instance's for use as a site-wide setting (appending a reference to the module it applies to, in order to avoid settings collisions).
+ The prefix to use for the setting name ( is used by default in the overloads that don't specify this parameter).
+ The formatted setting name, ready to be used as a site-wise setting key.
+
+
+ Gets the value of this setting for the given as a .
+ The type to which the value should be converted
+ The prefix to use for the setting name when it's not associated with a specific module instance ( is used by default in the overloads that don't specify this parameter).
+ The module configuration for a module instance to which this setting applies.
+ The default value to return if the setting has not been set yet.
+
+ A method which converts the representation of the value into a ,
+ returning null if the conversion was unsuccessful.
+
+
+ The value of this setting for the given
+ or if the value does not exist yet or cannot be converted to a
+
+
+
+ Gets the name of the key used to store and retrieve this setting.
+ The name of the setting's key.
+
+
+ Gets the scope of this setting.
+ The setting's scope.
+
+
+ Gets the default value.
+ The default value.
+
+
+ Represents a method that converts a string into a value-type, or returns null if the string cannot be converted.
+ The type into which the value is being converted
+ A representation of the value to be converted
+
+ The value contained in the parameter as a ,
+ or if cannot be converted into a ,
+ or null is is not a .
+
+
+
+
+ The base class for all settings controls in Engage DotNetNuke modules.
+
+
+
+
+ Builds a URL for this TabId, using the given queryString parameters.
+
+ The module id of the module for which the control key is being used.
+ The control key to determine which control to load.
+
+ A URL to the current TabId, with the given queryString parameters
+
+
+
+
+ Builds a URL for this TabId, using the given queryString parameters.
+
+ The module id of the module for which the control key is being used.
+ The control key to determine which control to load.
+ Any other queryString parameters.
+
+ A URL to the current TabId, with the given queryString parameters
+
+
+
+
+ Builds a URL for the given , using the given queryString parameters.
+
+ The tab id of the page to navigate to.
+ The module id of the module for which the control key is being used.
+ The control key to determine which control to load.
+ Any other queryString parameters.
+
+ A URL to the given , with the given queryString parameters
+
+
+
+
+ Builds a URL for the given , using the given queryString parameters.
+
+ The tab id of the page to navigate to.
+ The queryString parameters.
+
+ A URL to the given , with the given queryString parameters
+
+
+
+ Adds a reference to jQuery to this page.
+
+
+
+ Localizes the specified resource key, from this control's .
+
+ The resource key.
+
+ The localized text for the given
+
+
+
+
+ Localizes the specified resource key, from the given .
+
+ The resource key.
+ The path to the file with the localized resources.
+
+ The localized text for the given
+
+
+
+
+ Gets the resource file to use for resources that are shared across controls within a module.
+
+ The resource file for shared resources within the module.
+
+
+
+ Gets the name of the this module's desktop module record in DNN.
+
+ The name of this module's desktop module record in DNN.
+
+
+
+ Gets the name of the desktop module folder for this module.
+
+ The name of the desktop module folder for this module.
+
+
+
+ A design-time license
+
+
+
+
+ The type being licensed
+
+
+
+
+ Initializes a new instance of the class.
+
+ The type being licensed.
+ type is null.
+
+
+
+ Disposes of the resources used by the license.
+
+
+
+
+ Releases unmanaged and - optionally - managed resources
+
+ true to release both managed and unmanaged resources; false to release only unmanaged resources.
+
+
+
+ Gets the license key granted to this component.
+
+
+
+ A license key granted to this component.
+
+
+
+
+ Determines whether a given trial version of a module is still licensed.
+
+
+
+
+ Initializes a new instance of the class.
+
+ The license key for the module for which this license provider is to be used
+
+
+
+ Gets the message to display when the license evaluates as invalid.
+
+
+ The heading, message, and message type to display
+
+
+
+
+ Determines whether the site has a valid license for this module.
+
+ The control being validated.
+ The site's GUID.
+ The portal's name.
+
+ true if the site has a valid license for this module; otherwise, false.
+
+
+
+
+ A license provider that is always valid.
+
+
+
+
+ Initializes a new instance of the class.
+
+
+
+
+ Determines whether this instance represents a valid license.
+
+ The control requesting license validation.
+
+ true if this instance is valid; otherwise, false.
+
+
+
+
+ Gets the message to display when the license evaluates as invalid.
+
+
+ The heading, message, and message type to display
+
+
+
+
+ A runtime license
+
+
+
+
+ THe type being licensed
+
+
+
+
+ Initializes a new instance of the class.
+
+ The type being licensed.
+ type is null.
+
+
+
+ Disposes of the resources used by the license.
+
+
+
+
+ Releases unmanaged and - optionally - managed resources
+
+ true to release both managed and unmanaged resources; false to release only unmanaged resources.
+
+
+
+ Gets the license key granted to this component.
+
+
+
+ A license key granted to this component.
+
+
+
+ Gets the number of days left.
+ The number 5.
+
+
+
+ The base class for all non-settings controls in Engage DotNetNuke modules.
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Builds the link URL statically.
+
+ The tab id.
+ The module id.
+ The control key.
+ The query string parameters.
+ Url as a string.
+
+
+
+ Builds the link URL statically.
+
+ The tab id.
+ The query string parameters.
+ Url as a string.
+
+
+
+ Gets the QueryString control key for the current Request.
+
+ The module id.
+
+ The QueryString control key for the current Request
+
+
+
+
+ Builds a URL for this TabId, using the given queryString parameters.
+
+ The module id of the module for which the control key is being used.
+ The control key to determine which control to load.
+
+ A URL to the current TabId, with the given queryString parameters
+
+
+
+
+ Builds a URL for this TabId, using the given queryString parameters.
+
+ The module id of the module for which the control key is being used.
+ The control key to determine which control to load.
+ Any other queryString parameters.
+
+ A URL to the current TabId, with the given queryString parameters
+
+
+
+
+ Builds a URL for the given , using the given queryString parameters.
+
+ The tab id of the page to navigate to.
+ The module id of the module for which the control key is being used.
+ The control key to determine which control to load.
+ Any other queryString parameters.
+
+ A URL to the given , with the given queryString parameters
+
+
+
+
+ Builds a URL for the given , using the given queryString parameters.
+
+ The tab id of the page to navigate to.
+ The queryString parameters.
+
+ A URL to the given , with the given queryString parameters
+
+
+
+ Adds a reference to jQuery to this page.
+
+
+ Adds a reference to jQuery UI 1.8.16 and jQuery to this page.
+
+
+
+ Gets the QueryString control key for the current Request.
+
+ The QueryString control key for the current Request
+
+
+
+ Gets the instance representing the template in the given folder.
+
+ The name of the folder under the module's template folder that contains the template.
+ The instance representing the template in the given folder.
+ The provided template manifest does not conform to the EngageManifest schema.
+
+
+
+ Gets the list of instances representing the templates in this module's templates folder.
+
+ Type of the templates to retrieve.
+
+ The instance representing the template in the given folder.
+
+ The one of the templates' manifests does not conform to the EngageManifest schema.
+
+
+
+ Localizes the specified resource key, from this control's .
+
+ The resource key.
+
+ The localized text for the given
+
+
+
+
+ Localizes the specified resource key, from the given .
+
+ The resource key.
+ The path to the file with the localized resources.
+
+ The localized text for the given
+
+
+
+
+ Raises the event.
+
+ An object that contains the event data.
+
+
+
+ Handles the event of this control.
+
+ The source of the event.
+ The instance containing the event data.
+
+
+
+ Handles the event of this control.
+
+ The source of the event.
+ The instance containing the event data.
+
+
+
+ Gets the application URL.
+
+ The application URL.
+
+
+
+ Gets a value indicating whether the current user is logged in.
+
+
+ true if the current user is logged in; otherwise, false.
+
+
+
+
+ Gets the resource file to use for resources that are shared across controls within a module.
+
+ The resource file for shared resources within the module.
+
+
+
+ Gets the name of the this module's desktop module record in DNN.
+
+ The name of this module's desktop module record in DNN.
+
+
+
+ Gets the name of the desktop module folder for this module.
+
+ The name of the desktop module folder for this module.
+
+
+
+ Gets a value indicating whether the current user has edit rights to this module.
+
+ true if the current user can edit the module; otherwise, false.
+
+
+
+ Gets or sets the template provider to use for providing templating functionality within this control.
+
+ The template provider to use for providing templating functionality within this control
+ value is null.
+
+
+
+ Gets this control's page as the DNN Framework page.
+
+ The DNN Framework page on which this control sits, or null if it doesn't sit on the DNN Framework page.
+
+
+
+ Gets or sets the license provider to use for validating a license for this module.
+
+ The license provider to use for validating a license for this module.
+ value is null.
+
+
+
+ Gets or sets a value indicating whether this module should register a ScriptManager control on the page.
+
+
+ true if this module should register a ScriptManager control on the page; otherwise, false.
+
+
+
+
+ Gets a value indicating whether this instance is configured.
+
+ This can/should always be overwritten in
+ specific projects to decide what means configured for that module.
+
+
+ true if this instance is configured; otherwise, false.
+
+
+
+
+ The scope of the setting, how which instances of the module it affects
+
+
+
+
+ A setting that affects every instance of the module throughout the site.
+ Typically used for basic, fundamental setup necessary to use the module in any capacity.
+
+
+
+
+ A setting that affects an instance of a module, including any referenced copies of that module.
+ Typically used for settings that pertain to what data is being displayed by the module.
+
+
+
+
+ A setting that only affects a specific instance of a module on a page.
+ Typically used for settings that determine how the data of the module is being displayed.
+
+
+
+
+ A setting that only affects every instance of the module on a particular page.
+ Typically used for settings that affect a satellite module and the module it's connected to.
+
+
+
+
+ A setting that affects the entire installation.
+ Typically used in client implementations, possibly for information that needs to be accessible from scheduler or other services.
+
+
+
+
+ A setting that affects the entire installation.
+ Typically used in client implementations, possibly for information that needs to be accessible from scheduler or other services.
+ Stored in the web.config for easy changing between environments, without using the setting name prefix.
+
+
+
+
+ Information about the sub-controls loaded by a DotNetNuke module based on a key on the QueryString.
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Initializes a new instance of the struct.
+
+ The path to the control, relative to the module's .
+ if set to true this sub-control requires the user to have edit permission in order to view it.
+ is null
+ does not have a value
+
+
+
+ Implements the operator ==.
+
+ The left value.
+ The right value.
+ true if equals , otherwise false.
+
+
+
+ Implements the operator !=.
+
+ The left value.
+ The right value.
+ true if does not equal , otherwise false.
+
+
+
+ Indicates whether the current object is equal to another object of the same type.
+
+
+ true if the current object is equal to the parameter; otherwise, false.
+
+
+ An object to compare with this object.
+
+
+
+
+ Indicates whether this instance and a specified object are equal.
+
+ Another object to compare to.
+
+ true if and this instance are the same type and represent the same value; otherwise, false.
+
+
+
+
+ Returns the hash code for this instance.
+
+
+ A 32-bit signed integer that is the hash code for this instance.
+
+
+
+
+ Gets the path to the control, relative to the module's .
+
+ The path to the control
+
+
+
+ Gets a value indicating whether this sub-control requires the user to have edit permission in order to view it.
+
+
+ true if this sub-control requires the user to have edit permission in order to view it; otherwise, false.
+
+
+
+ The abstract class used by as the Presenter for all views that use Engage Templating.
+ The type of the view.
+ The type of the model.
+
+
+ Backing field for
+
+
+ Initializes a new instance of the class.
+ The view.
+
+
+ Gets the instance representing the template in the given folder.
+ The name of the folder under the module's template folder that contains the template.
+ The instance representing the template in the given folder.
+ The provided template manifest does not conform to the EngageManifest schema.
+
+
+ Gets the current page index from the query-string.
+
+
+ Gets or sets the template provider to use for providing templating functionality within this control.
+ The template provider to use for providing templating functionality within this control
+ value is null.
+
+
+ Gets the name of the desktop module associated with this view.
+ The name of the view's desktop module.
+
+
+ The view of a
+ The type of the model.
+
+
+
+ This method is used to process tags that aren't already handled by the ProcessCommonTags in this project or handled higher up
+ in the Engage.Dnn.Framework. See documentation for types of tokens already handled by the Framework.
+
+ The container to place the control.
+ The tag to parse.
+ The template item.
+ The resource file.
+ A true if the tag was handled by this process.
+
+
+
+ Base class for global template items
+
+
+
+
+ Defines the contract of an object which can be bound within the Engage templating system
+
+
+
+
+ Gets the value of the property with the given , or if a property with that name does not exist on this object or is null.
+
+
+ To avoid conflicts with template syntax, avoid using the following symbols in the property name
+
+ :
+ %
+ $
+ #
+ >
+ <
+ "
+ '
+
+
+ Name of the property.
+ The string representation of the value of this instance.
+
+
+
+ Gets the value of the property with the given , or if a property with that name does not exist on this object or is null.
+
+
+ To avoid conflicts with template syntax, avoid using the following symbols in the property name
+
+ :
+ %
+ $
+ #
+ >
+ <
+ "
+ '
+
+
+ Name of the property.
+
+ A numeric or DateTime format string, or one of the string formatting options accepted by ,
+ or null or to apply the default format.
+
+ The string representation of the value of this instance as specified by .
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Initializes a new instance of the class.
+
+
+
+
+ Gets the value of the property with the given , or if a property with that name does not exist on this object or is null.
+
+
+ To avoid conflicts with template syntax, avoid using the following symbols in the property name
+
+ :
+ %
+ $
+ #
+ >
+ <
+ "
+ '
+
+
+ Name of the property.
+ The string representation of the value of this instance.
+
+
+
+ Gets the value of the property with the given , or if a property with that name does not exist on this object or is null.
+
+
+ To avoid conflicts with template syntax, avoid using the following symbols in the property name
+
+ :
+ %
+ $
+ #
+ >
+ <
+ "
+ '
+
+
+ Name of the property.
+
+ A numeric or DateTime format string, or one of the string formatting options accepted by ,
+ or null or to apply the default format.
+
+ The string representation of the value of this instance as specified by .
+
+
+
+ Gets the current portal settings.
+
+
+
+
+ Gets the current user.
+
+
+
+
+ Gets the portal time zone.
+
+
+
+
+ Gets the user time zone.
+
+
+
+ A script library to reference when displaying a template
+
+
+ Backing field for
+
+
+ Backing field for
+
+
+ Backing field for
+
+
+ Initializes a new instance of the struct.
+ The library's name.
+ The version, or null.
+ The specificity of the , or null
+
+
+ Implements the == operator.
+ The left.
+ The right.
+ The result of the operator.
+
+
+ Implements the != operator.
+ The left.
+ The right.
+ The result of the operator.
+
+
+ Indicates whether the current object is equal to another object of the same type.
+ An object to compare with this object.
+ true if the current object is equal to the parameter; otherwise, false.
+
+
+ Returns a hash code for this instance.
+ A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
+
+
+ Determines whether the specified is equal to this instance.
+ Another object to compare to.
+ true if the specified is equal to this instance; otherwise, false.
+
+
+ Gets the library's name.
+
+
+ Gets the version, or null.
+
+
+ Gets the 's specificity, or null.
+
+
+ How specific the supplied version should be
+
+
+ The latest version of the library
+
+
+ The latest version of the library that adheres to the passed in major version
+
+
+ The latest version of the library that adheres to the passed in minor version
+
+
+ A script to reference when displaying a template
+
+
+ Backing field for
+
+
+ Backing field for
+
+
+ Backing field for
+
+
+ Initializes a new instance of the struct.
+ The script path.
+ The provider.
+ The priority.
+
+
+ Implements the == operator.
+ The left.
+ The right.
+ The result of the operator.
+
+
+ Implements the != operator.
+ The left.
+ The right.
+ The result of the operator.
+
+
+ Indicates whether the current object is equal to another object of the same type.
+ An object to compare with this object.
+ true if the current object is equal to the parameter; otherwise, false.
+
+
+ Determines whether the specified is equal to this instance.
+ Another object to compare to.
+ true if the specified is equal to this instance; otherwise, false.
+
+
+ Returns a hash code for this instance.
+ A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
+
+
+ Gets the script path.
+
+
+ Gets the provider.
+
+
+ Gets the priority.
+
+
+
+ A template provider for a single instance
+
+
+
+ Provides the main functionality for instantiating a template
+
+
+ The used to register JavaScript libraries on the page
+
+
+ The in DNN that corresponds to the enumeration
+
+
+ A dictionary mapping between a value and its corresponding value from the
+
+
+ A mapping between a JavaScript library name, and a method from before DNN 7.2 which registers it on the page
+
+
+
+ Initializes a new instance of the class.
+
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ A delegate which can be used to get a list of items to process, given an Engage:List tag.
+
+
+
+ Initializes a new instance of the class.
+
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ A delegate which can be used to get a list of items to process, given an Engage:List tag.
+ The initial item to use as context within the template, or null to provide no initial context.
+
+
+
+ Initializes a new instance of the class.
+
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ A delegate which can be used to get a list of items to process, given an Engage:List tag.
+ The initial item to use as context within the template, or null to provide no initial context.
+ A templateable item that represents global state.
+
+
+
+ Initialization code to run during a page's event.
+
+
+
+
+ When overridden in a subclass, causes operations to run during a page's event.
+
+
+
+
+ When overridden in a subclass, causes operations to run during a page's event.
+
+
+
+ Registers the script libraries.
+ The script libraries.
+
+
+ Registers the scripts.
+ The page.
+ The scripts.
+
+
+ Registers the style-sheet.
+ The page.
+ The style-sheet path, relative to the template.
+
+
+
+ Gets or sets a delegate which can be used to process the collection of tags that cannot be handled generically by the .
+
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+
+
+
+ Gets a delegate which can be used to get a list of items to process, given an Engage:List tag.
+
+ A delegate which can be used to get a list of items to process, given an Engage:List tag.
+
+
+
+ Gets the name of the template to use for the main display of content.
+
+ Name of the template to use for the main display of content.
+
+
+
+ Gets the container into which the main display of content should be injected.
+
+ The container into which the main display of content should be injected
+
+
+
+ Gets the initial item to use as context within the template, or null to provide no initial context.
+
+ The initial item to use as context within the template, or null to provide no initial context.
+
+
+
+ Gets the global item to use as fallback context within the template, or null to provide no global context.
+
+ The global item to use as fallback context within the template, or null to provide no global context.
+
+
+
+ Initializes a new instance of the class.
+
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ A delegate which can be used to get a list of items to process, given an Engage:List tag.
+ The item for which the template should be instantiated.
+ A templateable item that represents global state.
+
+
+
+ Initializes a new instance of the class.
+
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ A delegate which can be used to get a list of items to process, given an Engage:List tag.
+ The item for which the template should be instantiated.
+
+
+
+ Implementation of for getting a instance from a manifest file
+
+
+
+
+ Represents the contract for a class able to get a object based on the templates folder path and the template folder name
+
+
+
+
+ Gets the XML document for a template manifest
+
+ The name of the folder under the module's template folder that contains the template.
+ The instance representing the template manifest for a template
+
+
+
+ Gets the text content of the template file.
+
+ The name of the folder under the module's template folder that contains the template.
+ The filename of the template file.
+ The text content of the template file
+
+
+
+ Gets the list of folders under the module's template folder.
+
+ A list of the names of the folders under the module's template folder
+
+
+
+ Gets the relative path for the given .
+
+ The name of the folder under the module's template folder that contains the template.
+ Name of the file to qualify with the path.
+ A relative path to the given
+
+
+
+ Gets the physical file path for the given .
+
+ The name of the folder under the module's template folder that contains the template.
+ Name of the file to qualify with the path.
+ The physical file path to the given
+
+
+
+ The name of the module's desktop module record in DNN
+
+
+
+
+ The name of the templates' subdirectory, or null to look in the module's main Templates directory
+
+
+
+
+ Initializes a new instance of the class.
+
+ The name of the module's desktop module record in DNN.
+
+
+
+ Initializes a new instance of the class.
+
+ The name of the module's desktop module record in DNN.
+ The name of the templates' subdirectory, or null to look in the module's main Templates directory
+
+
+
+ Gets the XML document for a template manifest
+
+ The name of the folder under the module's template folder that contains the template.
+
+ The instance representing the template manifest for a template
+
+ templateFolderName is null.
+ Template manifest is not well-formed.
+
+
+
+ Gets the text content of the template file.
+
+ The name of the folder under the module's template folder that contains the template.
+ The filename of the template file.
+ The text content of the template file
+
+ The specified path, file name, or both exceed the system-defined maximum length.
+ For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
+ An I/O error occurred while opening the file.
+
+ Path specified a file that is read-only.
+ -or-
+ This operation is not supported on the current platform.
+ -or-
+ Path specified a directory.
+ -or-
+ The caller does not have the required permission.
+
+ The caller does not have the required permission.
+ Unable to find the specified file
+
+
+
+ Gets the list of folders under the module's template folder.
+
+ A list of the names of the folders under the module's template folder
+ The caller does not have the required permission.
+
+ The specified path, file name, or both exceed the system-defined maximum length.
+ For example, on Windows-based platforms, paths must be less than 248 characters and file names must be less than 260 characters.
+
+ The specified path is invalid (for example, it is on an unmapped drive).
+
+
+
+ Gets the relative path for the given .
+
+ The name of the folder under the module's template folder that contains the template.
+ Name of the file to qualify with the path.
+
+ A relative path to the given
+
+
+
+
+ Gets the physical file path for the given .
+
+ The name of the folder under the module's template folder that contains the template.
+ Name of the file to qualify with the path.
+
+ The physical file path to the given
+
+
+
+
+ Throws a generic message when a template file (with the given ) cannot be found.
+
+ The actual exception thrown when trying to read the file.
+ The full name of the file that could not be found.
+ Unable to find the specified file
+
+
+
+ A null implementation of to use for control that are not templated
+
+
+
+
+ Initializes a new instance of the class.
+
+
+
+
+ Initialization code to run during a page's event.
+
+
+
+ A listing with paging tokens.
+
+
+
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ This will be called from
+
+
+
+ Initializes a new instance of the class.
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ The URL to use for the paging buttons, with the page number templated out for use with (that is, "{0}").
+ The state of the paging for this list of items.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ The delegate to use to get the list of items to process.
+
+
+ Initializes a new instance of the class.
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ The URL to use for the paging buttons, with the page number templated out for use with (that is, "{0}").
+ The state of the paging for this list of items.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ The delegate to use to get the list of items to process.
+ The initial template item.
+
+
+ Initializes a new instance of the class.
+ Name of the template to use for the main display of content.
+ The container into which the main display of content should be injected.
+ The URL to use for the paging buttons, with the page number templated out for use with (that is, "{0}").
+ The state of the paging for this list of items.
+ A delegate which can be used to process the collection of tags that cannot be handled generically by the .
+ The delegate to use to get the list of items to process.
+ The initial template item.
+ A templateable item that represents global state.
+
+
+ Initialization code to run during a page's event.
+
+
+
+ Sets the property of a potentially-null to the value of the given .
+
+ The control to set visibility on.
+ if set to true's property is set to true, otherwise false.
+
+
+
+ Method used to process a token. This method is invoked from the class. Since this control knows
+ best on how to construct the page. ListingHeader, ListingItem and Listing Footer templates are processed here.
+
+ The container.
+ The tag being processed.
+ The engage object.
+ The resource file to use to find get localized text.
+ Whether to process the tag's ChildTags collection
+
+
+ Creates the start item.
+ The tag.
+ The template item.
+ The resource file.
+ Returns a label for the start number
+
+
+ Creates the start item.
+ The tag.
+ The template item.
+ The resource file.
+ Returns a label for the start number
+
+
+ Creates a label with the current page number and total page count.
+ The tag.
+ The template item.
+ The resource file.
+ A instance.
+
+
+ Creates a label with the current page number.
+ The tag.
+ The template item.
+ The resource file.
+ A instance.
+
+
+ Creates a link to the next page (hiding the link if it is the last page).
+ The tag being processed.
+ The engage object.
+ The resource file to use to find get localized text.
+ A new instance.
+
+
+ Creates a link to the previous page (hiding the link if it is the first page).
+ The tag being processed.
+ The engage object.
+ The resource file to use to find get localized text.
+ A new instance.
+
+
+ Creates the page count label.
+ The tag being processed.
+ The engage object.
+ The resource file to use to find get localized text.
+ A new instance.
+
+
+ Creates the page list.
+ The tag being processed.
+ The engage object.
+ The resource file to use to find get localized text.
+ A new instance.
+
+
+ Hides the when there aren't multiple pages.
+ The control.
+ The tag being processed.
+ The engage object.
+ The resource file to use to find get localized text.
+
+
+ Gets or sets the state of the paging for this list of items.
+ The state of the paging for this list of items
+
+
+
+ Gets the URL to use for the paging buttons, with the page number templated out for use with (that is, "{0}").
+
+ The URL to use for the paging buttons, with the page number templated out for use with (that is, "{0}").
+
+
+ Represents the information contained in a template's manifest file
+
+
+ The namespace URL for the Engage Manifest schema
+
+
+ A schema set which contains the EngageManifest schema
+
+
+ The template provider to use to interact with the template files
+
+
+ Initializes a new instance of the class.
+ The folder under the module's template folder in which this template resides.
+ The template provider to use to interact with the template files.
+
+
+ Gets a list of the templates provided by .
+ The template manifest provider.
+ A list of instances for the available templates
+ templateProvider is null.
+ The provided template manifest does not conform to the EngageManifest schema.
+
+
+ Gets a list of the templates provided by .
+ The template manifest provider.
+ Type of the templates to retrieve.
+ A list of instances for the available templates
+ templateProvider is null.
+ The provided template manifest does not conform to the EngageManifest schema.
+
+
+ Gets a instance representing the manifest provided by the .
+ The template manifest provider.
+ The name of the folder under the module's template folder that contains the template.
+ A instance representing the manifest provided by the
+ templateProvider is null.
+ The provided template manifest does not conform to the EngageManifest schema.
+ Unable to find the template file specified in the manifest
+ If an XML namespace if specified, it must be the correct EngageManifest namespace:
+
+
+ Gets the relative path for the given .
+ Name of the file to qualify with the path.
+ if set to true adds a ~ to the front of the relative path.
+ A relative path to the given
+
+
+ Gets the physical file path for the given .
+ Name of the file to qualify with the path.
+ The physical file path to the given
+
+
+ Gets a list of the templates provided by .
+ The template manifest provider.
+ Type of the templates to retrieve, or null to retrieve all types.
+ A list of instances for the available templates
+ templateProvider is null.
+ The provided template manifest does not conform to the EngageManifest schema.
+
+
+ Validates the given against the EngageManifest schema,
+ throwing an if it doesn't.
+ The manifest navigator.
+ The name of the folder in which the template for this manifest is found
+ The provided template manifest does not conform to the EngageManifest schema.
+ Could not find Engage.Dnn.Framework.Templating.EngageManifest.xsd embedded resource
+
+
+ Creates the .
+ An containing the EngageManifest schema
+
+ Could not find Engage.Dnn.Framework.Templating.EngageManifest.xsd embedded resource
+ or
+ Could not find Engage.Dnn.Framework.Templating.NamespacedEngageManifest.xsd embedded resource
+
+
+
+ Gets the value of the single node specified by the given expression.
+ The representing the template manifest.
+ A representing an XPath expression.
+ The object used to resolve namespace prefixed in the XPath query.
+ The value of the node
+
+
+ Gets the value of the attribute as a .
+ The type of the attribute's value
+ An pointing to the element containing the attribute.
+ The name of the attribute.
+ A function which gets the value of the attribute, given an pointing to the attribute.
+ A instance, or the default value of .
+
+
+ Converts the to a .
+ An pointing to a Script node.
+ A new instance.
+
+
+ Converts the to a .
+ An pointing to a Library node.
+ A new instance.
+
+
+ Gets the description of this template.
+
+
+ Gets the folder under the module's template folder in which this template resides
+
+
+ Gets the name of the module that this template is for.
+
+
+ Gets the filename of the image to display as a preview of the template.
+
+
+ Gets the resource file.
+
+
+ Gets the filename of the style-sheet for this template.
+
+
+ Gets the template.
+
+
+ Gets the filename of the template file.
+
+
+ Gets the title of this template.
+
+
+ Gets the type of the template.
+
+
+ Gets the list of module settings to set when applying this template.
+
+
+ Gets the list of the scripts to reference when applying this template.
+
+
+ Gets the list of the scripts to reference when applying this template.
+
+
+ Gets the list of the scripts to reference when applying this template.
+
+
+ A dynamic placeholder within a
+
+
+ Backing field for
+
+
+ Backing field for
+
+
+ Backing field for
+
+
+ Backing field for
+
+
+ Initializes a new instance of the class.
+ The type of placeholder.
+ The main value.
+ The value's format.
+ The complete placeholder text.
+
+
+ Gets the type of placeholder.
+ The placeholder type.
+
+
+ Gets the main value of the placeholder.
+ The placeholder value (e.g. the resource key or data-bound property).
+
+
+ Gets the format for the value.
+ The value's format.
+
+
+ Gets the entire text of the placeholder.
+ The placeholder's text.
+
+
+ The type of a
+
+
+ An unknown (probably invalid) placeholder type
+
+
+ Binding to a value from an instance, represented by #
+
+
+ Binding to text from resource file, represented by $
+
+
+
+ Represents a method that can process a tag for a template
+
+ The container into which created controls should be added
+ The tag to process
+ The object to query for data to implement the given tag
+ The resource file to use to find get localized text.
+ Whether to process the tag's ChildTags collection
+
+
+
+ Represents a method that can get a list of items given an Engage:List tag and the current item being processed, if any.
+
+
+ The parameter should always be null unless the Engage:List tag is nested inside of another Engage:List.
+
+ The Engage:List for which to return a data source
+ The current item being processed, or null if no list is currently being processed
+ A list of the items over which the given should be processed
+
+
+
+ Gets and processes s
+
+
+
+
+ A regular expression which matches a dynamic value placeholder within an attribute.
+ Captures three names groups:
+
+
+ Group Name
+ Group Contents
+
+
+ PlaceholderType
+ # for data-bound placeholders, $ for localized resource placeholders
+
+
+ Value
+ The value (property name for data-bound placeholders, resource key for localization placeholders)
+
+
+ Format
+ An optional format string
+
+
+
+ [^%:""\s]+)], zero or one repetitions
+ \:\s*(?[^%:""\s]+)
+ Literal :
+ Whitespace, any number of repetitions
+ [Format]: A named capture group. [[^%:""\s]+]
+ Any character that is NOT in this class: [%:""\s], one or more repetitions
+ \s*%
+ Whitespace, any number of repetitions
+ Literal %
+ ]]>
+
+
+ Formats the given string, based on the encoding formats supported by the template.
+ The value to format.
+
+ The format string, a comma-delimited list of HTML, CSS/SLUG, ATTR/ATTRIBUTE, JAVASCRIPT, CLEAN, and RAW (defaults to RAW).
+
+ The formatted according to the given
+
+
+
+ Processes all of the tags in the given list of
+
+ The container into which controls are to be added.
+ The list of tags being processed.
+ The object which should be queried for data.
+ The resource file to use to find get localized text.
+ Delegate method used for tags that cannot be processed by this method.
+ The delegate to use to get the list of items to process.
+
+
+
+ Processes all of the tags in the given list of
+
+ The container into which controls are to be added.
+ The list of tags being processed.
+ The object which should be queried for data.
+ A templateable item that represents global state.
+ The resource file to use to find get localized text.
+ Delegate method used for tags that cannot be processed by this method.
+ The delegate to use to get the list of items to process.
+
+
+ Gets all of the placeholders anywhere within the (or their descendants).
+ The tags.
+ A sequence of instances.
+
+
+
+ Gets the text value of an attribute on the given . The attribute can use data-binding syntax, %#PropertyName%, to look
+ up a value with the given property for the current . It can also use resource file syntax, %$ResourceKey%, to
+ look up the value of the given key in the . Otherwise returns the plain text of the attribute value.
+
+ The tag whose content is being represented.
+ The object from which to get the property if data-binding syntax is used.
+ The resource file from which to get localized resources if resource file syntax is used.
+ Name of the attribute whose value to get.
+
+ The text value of the given attribute from the given tag, looking up a value from the given or
+ if the correct syntax is used
+
+
+
+
+ Gets the text value of an attribute on the given . The attribute can use data-binding syntax, %#PropertyName%, to look
+ up a value with the given property for the current . It can also use resource file syntax, %$ResourceKey%, to
+ look up the value of the given key in the . Otherwise returns the plain text of the attribute value.
+
+ The tag whose content is being represented.
+ The object from which to get the property if data-binding syntax is used.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources if resource file syntax is used.
+ Name of the attribute whose value to get.
+
+ The text value of the given attribute from the given tag, looking up a value from the given or
+ if the correct syntax is used
+
+
+
+
+ Gets the text value of an attribute on the given . The attribute can use data-binding syntax, %#PropertyName%, to look
+ up a value with the given property for the current . It can also use resource file syntax, %$ResourceKey%, to
+ look up the value of the given key in the . Otherwise returns the plain text of the attribute value.
+
+ The tag whose content is being represented.
+ The object from which to get the property if data-binding syntax is used.
+ The resource file from which to get localized resources if resource file syntax is used.
+ Name of the attribute whose value to get.
+ Name of an alternate attribute to check if doesn't have a value.
+
+ The text value of the given attribute from the given tag, looking up a value from the given or
+ if the correct syntax is used
+
+
+
+
+ Gets the text value of an attribute on the given . The attribute can use data-binding syntax, %#PropertyName%, to look
+ up a value with the given property for the current . It can also use resource file syntax, %$ResourceKey%, to
+ look up the value of the given key in the . Otherwise returns the plain text of the attribute value.
+
+ The tag whose content is being represented.
+ The object from which to get the property if data-binding syntax is used.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources if resource file syntax is used.
+ Name of the attribute whose value to get.
+ Name of an alternate attribute to check if doesn't have a value.
+
+ The text value of the given attribute from the given tag, looking up a value from the given or
+ if the correct syntax is used
+
+
+
+ Adds the given to the given unless is null.
+ The container to which is to be added.
+ The control to add to .
+ is null
+
+
+ Adds the created by calling to the given unless the control is null.
+ The container to which the control is to be added.
+ A function which creates the control to add to .
+ or are null
+
+
+
+ Adds the given to the given unless is null.
+
+ The container.
+ The header text.
+
+
+
+ Creates a for the given ,
+ with the given Text property,
+ also setting the and
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The text of the label.
+ The instance that was created
+
+
+
+ Creates a for the given ,
+ with the given Text property,
+ also setting the and
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The text of the label.
+ The attributes which have been processed and should be excluded from passing through to the generated markup.
+ The instance that was created
+ is null
+
+
+
+ Creates a for the given ,
+ with the given Text property,
+ also setting the and
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+ The text of the label.
+ The instance that was created
+
+
+ Creates a for the given ,
+ with the given Text property,
+ also setting the and
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+ The text of the label.
+ The attributes which have been processed and should be excluded from passing through to the generated markup.
+ The instance that was created
+ is null
+
+
+ Creates an a tag for the given .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The URL to which the link points
+ The created
+
+
+ Creates an a tag for the given .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The URL to which the link points
+ The attributes which have been processed and should be excluded from passing through to the generated markup.
+ The created
+ is null
+
+
+
+ Creates an a tag for the given .
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+ The URL to which the link points
+ The created
+
+
+ Creates an a tag for the given .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+ The URL to which the link points
+ The attributes which have been processed and should be excluded from passing through to the generated markup.
+ The created
+ is null
+
+
+ Creates an instance.
+ The rel attribute's value.
+ The href attribute's value.
+ A new instance.
+ or are null
+
+
+ Adds additional attributes to the .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The control to which to add the attributes.
+ The list of attributes which have already been processed.
+ is null -or- is null -or- is null
+
+
+ Adds additional attributes to the .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The control to which to add the attributes.
+ The list of attributes which have already been processed.
+ is null -or- is null -or- is null
+
+
+ Adds additional attributes to the .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The control to which to add the attributes.
+ The list of attributes which have already been processed.
+ is null -or- is null -or- is null
+
+
+ Adds additional attributes to the .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The control to which to add the attributes.
+ The list of attributes which have already been processed.
+ is null -or- is null -or- is null
+
+
+ Adds additional attributes to a control's .
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The list of attributes which have already been processed.
+ The attribute collection to which to add the attributes.
+ is null -or- is null
+
+
+
+ Creates a literal text control for the given ,
+ as defined on the Text attribute of the
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+
+ The instance that was created
+
+
+
+
+ Creates a for the given ,
+ with the given Text property,
+ also setting the and
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+ The instance that was created
+
+
+
+ Creates a for the given ,
+ with the given Text property,
+ also setting the and
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+ The instance that was created
+
+
+
+ Creates an for the given .
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+
+ The instance that was created
+
+
+
+
+ Creates an a tag for the given .
+
+ The tag whose content is being represented.
+ The object from which to get the property.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+
+ The created link
+
+
+
+
+ Gets a value indicating whether to display this tag and its children, based on the conditional attributes (if and unless).
+
+ The tag to check.
+ The template item.
+ A templateable item that represents global state.
+ The resource file.
+ Whether to display the contents of
+
+
+
+ Gets the value of a property.
+
+ Name of the property.
+ The property format.
+ The template item from which to get the property's value.
+ The global item from which to get the value if doesn't have it.
+ The formatted value of the property, or null
+
+
+ Gets all of the tags as a flat list.
+ The tags.
+ A sequence of instances.
+
+
+ Gets the dynamic placeholder(s) for the given .
+ The attribute value.
+ A sequence of instances.
+
+
+ Creates a placeholder to represent the attribute being set via the secondary syntax (e.g. Property-PropertyName).
+ The tag.
+ The attribute's name.
+ A new instance (with null), or null.
+
+
+
+ Processes a regular HTML tag that has an embedded as an attribute value.
+
+ The tag whose content is being represented.
+ The object from which to get data.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process the embedded tag.
+ The delegate to use to get the list of items to process.
+ A control representing the tag
+
+
+
+ Processes an Engage:List tag, repeating its content for each item in a given list of data
+
+ The list tag being represented.
+ The item for which this list is being processed, null unless we're in a nested list.
+ A templateable item that represents global state.
+ The resource file from which to get localized resources.
+ The delegate to use to process tags that can't.
+ The delegate to use to get the list of items to process.
+ A control representing the tag
+
+
+ Processes the no data token.
+ The no data tag.
+ The context item.
+ The global item.
+ The resource file.
+ The process tag.
+ The get list data.
+ The no data
+
+
+
+ Creates an instance of to use to render tags.
+
+ The to write to.
+ An instance of to use when rendering tags
+
+
+
+ The type of template
+
+
+
+
+ A list of items
+
+
+
+
+ A single item
+
+
+
+
+ A collection of utility methods dependent on DotNetNuke.
+
+
+
+
+ A mapping from time zone offset to the ID of a , for use by
+
+
+
+ Gets the login URL for the given portal from the current .
+ The portal settings.
+ The request.
+ The URL for the login page
+ if or is null.
+
+
+ Gets the login URL for the given portal from the current .
+ The portal settings.
+ The request.
+ The URL for the login page
+ if or is null.
+
+
+
+ Gets a non-deleted instance of the module with the given .
+
+ The portal id.
+ The module definition.
+ A non-deleted with the given , or null if none exists.
+
+
+
+ Creates a URL from a DNN URL Control, mapping a tabId, fileId, userId, or URL link to a working URL.
+
+ A DNN URL Control (a ).
+ The portal settings.
+ The (relative) URL that this control points to.
+
+
+
+ Creates a URL from a DNN URL Control, mapping a tabId, fileId, userId, or URL link to a working URL.
+
+ A Dnn URL Control (a ).
+ The portal settings.
+ if set to true the path returned will be relative, otherwise it will be absolutely rooted to this application and portal alias (unless the user explicitly provides a relative path, then it will always be relative).
+ The URL that this control points to.
+ if is null
+
+
+
+ Removes the first section of a URL if it starts with HTTP, effectively making it a relative path.
+
+ The URL to make relative.
+ as a relative URL.
+
+
+
+ Localizes a list control (, ).
+
+ The list control.
+ The resource file.
+ if is null
+
+
+
+ Localizes a grid view. If you are targeting DNN 4.6.0 or higher, use Localization.LocalizeGridView.
+
+ The grid view to be localized.
+ The resource file.
+ if is null.
+
+
+
+ Gets the time zone offset of the given user, or for the portal if the user is not logged in.
+
+ The user info.
+ The portal settings.
+ The time zone offset of the given user.
+
+
+
+ Gets the time zone of the current user, or for the portal if the user is not logged in.
+
+ The time zone of the current user.
+
+
+
+ Gets the time zone of the given user, or for the portal if the user is not logged in.
+
+ The user info.
+ The portal settings.
+ The time zone of the given user.
+
+
+
+ Gets the time zone of the current portal.
+
+ The time zone of the current portal.
+
+
+
+ Gets the time zone of the given portal if the user is not logged in.
+
+ The portal settings.
+ The time zone of the given portal.
+
+
+ Gets the resource file to use for resources that are shared across controls within a module.
+ The name of the module's desktop module record in DNN.
+ The resource file for shared resources within the module.
+
+
+
+ Converts old TimeZoneOffset to new .
+
+ An offset in minutes, e.g. -480 (-8 times 60) for Pacific Time Zone
+
+ A specific is returned if is valid,
+ otherwise is returned.
+
+
+ Based on DNN 6.1.2 method from .
+ Initial mapping is based on hard-coded rules. These rules are hard-coded from old standard TimeZones.xml data.
+ When offset is not found hard-coded mapping, a lookup is performed in time zones defined in the system. The first found entry is returned.
+ When mapping is not found, is returned.
+
+
+
+
+ Sets up and returns a DNN text editor control in the given control.
+
+ The text editor place holder.
+ The control that has been created.
+
+
+
+ Sets up and returns a DNN text editor control in the given control.
+
+ The text editor place holder.
+ The height.
+ The width.
+ The control that has been created.
+
+
+
+ Sets up and returns a DNN text editor control in the given control.
+
+ The text editor place holder.
+ The height.
+ The width.
+ The text render mode. Possible values include "Raw," "HTML," and "Text."
+ if set to true the user can choose the .
+ The control that has been created.
+
+
+
+ Sets up and returns a DNN text editor control in the given control.
+
+ The text editor place holder.
+ The height.
+ The width.
+ The text render mode. Possible values include "Raw," "HTML," and "Text."
+ if set to true the user can choose the .
+ The default mode (of "Basic" or "Rich") to show the user, if they don't have a preference in their profile.
+ They usually will, this is not a valid method by which to restrict the user to either mode.
+ if set to true the user can choose whether to have a basic or rich text editor.
+
+ The control that has been created.
+
+
+
+
+ Sets up and returns a DNN text editor control in the given control.
+
+ The text editor place holder.
+ The height.
+ The width.
+ The text render mode. Possible values include "Raw," "HTML," and "Text."
+ if set to true the user can choose the .
+ The default mode (of "Basic" or "Rich") to show the user, if they don't have a preference in their profile.
+ They usually will, this is not a valid method by which to restrict the user to either mode.
+ if set to true the user can choose whether to have a basic or rich text editor.
+ if set to true the text value is HTML encoded.
+
+ The control that has been created.
+
+
+
+
+ Utility function to set data source of a drop down control.
+ Expects DisplayMember and ValueMember fields
+
+ The drop down control whose data source is being set
+ The object from which the data-bound control receives its list of data items
+
+
+
+ Gets the physical path to the templates folder.
+
+ The name of this module's desktop module record in DNN.
+ The physical path to the templates folder.
+
+
+
+ Gets the full physical path to the desktop module folder.
+
+ The name of the module's desktop module record in DNN.
+ The full physical path to the module's desktop module folder.
+
+
+
+ Gets the relative path to the templates folder.
+
+ The name of this module's desktop module record in DNN.
+ The relative path to the templates folder.
+
+
+
+ Gets the relative path to the templates folder.
+
+ The name of this module's desktop module record in DNN.
+
+ The relative path to the templates folder.
+
+
+
+
+ Gets the name of the desktop module folder.
+
+ The name of the module's desktop module record in DNN.
+ The name of this module's desktop module folder.
+
+
+
+ Installs the comments and ratings database objects into the DNN database.
+
+
+
+
+ Gets the contents of the SQL script to create the comments and ratings database objects.
+
+ A SQL script that can be run to ensure that the comments and ratings database objects exist.
+
+
+ Adds the requested script to the bottom of the page.
+ The page.
+ The script's filename (e.g. redirectOnSelect.js).
+ is null
+
+
+ Request jQuery to be included on the page
+
+
+ Request jQuery to be included on the page
+ Not used
+
+
+
+ Adds a reference to jQuery UI 1.8.16 (minified) to the page. If you can reference DNN 6.0 or higher, use the built-in methods to register jQuery UI, instead.
+
+
+ Also adds jQuery prior to UI.
+ Also checks for duplicates, only adding the reference once regardless of how many times this method is called for the .
+
+ The page to which the reference will be added.
+
+
+
+ Gets the given setting as a or null if the setting is not set
+
+ The settings collection.
+ Name of the setting.
+ The setting as a
+
+
+
+ Gets the given setting as a or null if the setting is not set
+
+ The settings collection.
+ Name of the setting.
+ The setting as a
+
+
+
+ Gets the given setting as a , or if the setting is not set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The setting or default as a
+
+
+
+ Gets the given setting as a , or if the setting is not set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The setting or default as a
+
+
+
+ Gets the given setting as an , or null if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The setting as a , or null if the setting hasn't been set.
+
+
+
+ Gets the given setting as an , or null if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The setting as a , or null if the setting hasn't been set.
+
+
+
+ Gets the given setting as an , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as an , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as an , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as an , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or null if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ Gets the given setting as an , or null> if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or null if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ Gets the given setting as an , or null> if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings.
+ Name of the setting.
+ The default value.
+ Gets the given setting as an , or if the setting hasn't been set.>
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings.
+ Name of the setting.
+ The default value.
+ Gets the given setting as an , or if the setting hasn't been set.>
+
+
+
+ Gets the given setting as a , or null if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The given setting as a , or null if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or null if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The given setting as a , or null if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or null if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ settings is null.
+ settingName is null.
+ The given setting as a , or null if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ settings is null.
+ settingName is null.
+ The given setting as a , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or null if the setting hasn't been set.
+
+ Type of the enum which the setting value should be.
+ The settings collection.
+ Name of the setting.
+ The given setting as a , or null if the setting hasn't been set.
+ if T is not an enum type
+
+
+
+ Gets the given setting as a , or null if the setting hasn't been set.
+
+ Type of the enum which the setting value should be.
+ The settings collection.
+ Name of the setting.
+ The given setting as a , or null if the setting hasn't been set.
+ if T is not an enum type
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ Type of the enum which the setting value should be.
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+ if T is not an enum type
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ Type of the enum which the setting value should be.
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+ if T is not an enum type
+
+
+
+ Gets the given setting as an , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as an , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ The settings collection.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+ settings is null.
+ settingName is null.
+
+
+
+ Gets the given setting as a , or if the setting hasn't been set.
+
+ Type of the which the setting value should be.
+ The settings.
+ Name of the setting.
+ The default value.
+ The given setting as a , or if the setting hasn't been set.
+ if T is not an type
+
+
+
+ Includes the jQuery library onto the page
+
+ Based on
+ Page object from calling page/control
+
+
+
+ Returns a version-safe set of version numbers for DNN
+
+ out value of major version (i.e., 4,5 etc)
+ out value of minor version (i.e., 1 in 5.1 etc)
+ out value of revision (i.e., 3 in 5.1.3)
+ out value of build number
+
+ Based on
+ DNN moved the version number during about the 4.9 version,
+ which to [Bruce] was a bit frustrating and caused the need for this reflection method call
+ true if successful, false if not
+
+
+
+ Adds a script tag to the page's header.
+
+ The page.
+ The script src attribute (for a remove script).
+ The script tag's ID.
+ The script's text (for an inline script).
+
+
+
+ All common, shared functionality for Engage Modules.
+
+
+
+
+ The host setting key base for whether this module have been configured
+
+
+
+
+ Gets the name of the desktop module folder.
+
+ The name of the module's desktop module record in DNN.
+ The name of this module's desktop module folder.
+
+
+
+ Gets the relative path to the templates folder.
+
+ The name of this module's desktop module record in DNN.
+
+ The relative path to the templates folder.
+
+
+
+
+ Gets the relative path to the templates folder.
+
+ The name of this module's desktop module record in DNN.
+ The relative path to the templates folder.
+
+
+
+ Gets the full physical path to the desktop module folder.
+
+ The name of the module's desktop module record in DNN.
+ The full physical path to the module's desktop module folder.
+
+
+
+ Gets the physical path to the templates folder.
+
+ The name of this module's desktop module record in DNN.
+ The physical path to the templates folder.
+
+
+
+ Gets the physical path to the templates folder.
+
+ The name of this module's desktop module record in DNN.
+ The physical path to the templates folder.
+
+
+
+ Utility function to set data source of a drop down control.
+
+ The drop down control whose data source is being set
+ The object from which the data-bound control receives its list of data items
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/Source/References/Framework/Engage.Dnn.Framework.dll b/Source/References/Framework/Engage.Dnn.Framework.dll
index 8978917..8351f76 100644
Binary files a/Source/References/Framework/Engage.Dnn.Framework.dll and b/Source/References/Framework/Engage.Dnn.Framework.dll differ
diff --git a/Source/References/Framework/Engage.Events.dll b/Source/References/Framework/Engage.Events.dll
deleted file mode 100644
index a9bc127..0000000
Binary files a/Source/References/Framework/Engage.Events.dll and /dev/null differ
diff --git a/Source/References/Framework/Engage.Framework.XML b/Source/References/Framework/Engage.Framework.XML
new file mode 100644
index 0000000..3ee501d
--- /dev/null
+++ b/Source/References/Framework/Engage.Framework.XML
@@ -0,0 +1,7397 @@
+
+
+
+ Engage.Framework
+
+
+
+
+ Summary description for AffectedObjectsContainer.
+
+
+
+
+ Summary description for IAffectedObjectsContainer.
+
+
+
+
+ This interface is the common reference type between Engage and ASPNET/DNN Membership users.
+
+
+
+
+ Is this Entity saveable to the database. At this level, is the object's state been changed
+
+
+
+
+
+ Is this Entity's state valid. By default, it is.
+
+
+
+
+
+ This method is used to flush an existing Entity and reuse it.
+
+ This method has not been tested
+
+
+
+ Please tell me you don't have to actually do this.HK
+
+
+
+
+
+ Has this instance been loaded from the database
+
+
+
+
+ Has the state of this instance changed since being loaded from the database
+
+
+
+
+ Is this instance a newly created object, not belonging to the database
+
+
+
+
+
+
+
+
+
+ Affiliate child to this EntityContainer. The type is determined by the type of child.
+
+ The EntityContainer instance to add
+
+
+
+ This represents a Secure Container in the WinForms treeview application.
+
+
+
+
+ This object reprents a EntityContainer that supports children
+
+
+
+
+ Summary description for EntityContainer.
+
+
+
+
+ This constructor creates an empty Entity that is not yet part of the database. IE: Creating a new object.
+
+
+
+
+ Is this Entity saveable to the database. At this level, is the object's state been changed
+
+
+
+
+
+ Is this Entity's state valid. By default, it is.
+
+
+
+
+
+ This method is used to flush an existing Entity and reuse it.
+
+ This method has not been tested
+
+
+
+ Used primarily when loading an object from the db to prevent the object from being set to dirty
+
+
+
+
+ Used primarily when loading an object from the db is complete, to allow the dirty mechanism to function normally
+
+
+
+
+ Has this instance been loaded from the database
+
+
+
+
+ Has the state of this instance changed since being loaded from the database
+
+
+
+
+ Is this instance a newly created object, not belonging to the database
+
+
+
+
+ Version Manager inner class.
+
+
+
+
+
+
+
+
+
+ This method is used to flush an existing Entity and reuse it.
+
+ This method has not been tested
+
+
+
+ Removes child
+
+
+
+
+
+ Removes all children
+
+
+
+
+ Removes all children of the specified type
+
+
+
+
+ This method is provided for situations where you don't know the parent's type but you do have
+ a common AffiliationType for parents.
+
+ Note: This method returns the first parent that is found for the specified type and does not
+ recurse up.
+
+
+
+
+
+ Returns an IEntityContainer[] of parents of the given type of this object
+
+
+
+
+
+
+ Loads a EntityContainer from the database if not previously cached
+
+ id of the EntityContainer to load
+ A loaded EntityContainer
+
+
+
+
+ Loads a EntityContainer from the database if not previously cached
+
+ id of the EntityContainer to load
+ should this objectID be reloaded from the database
+ A loaded EntityContainer
+ value
+ remarks
+
+
+
+
+
+ Is this EntityContainer saveable to the database. This is defined as all the
+ required attributes are valid
+
+
+
+
+
+ Is this EntityContainer's state valid. Defined as all attributes are valid and
+ all ObjectRules are passed
+
+
+
+
+
+ Returns an IConsoleNode for every instance of this type. Providing this method in a subclass prevents
+ defining via the database
+
+
+
+ Returns an IConsoleNode for every instance of this type. Providing this method in a subclass prevents
+ defining via the database
+
+
+
+
+
+ Overridden by subclass to act as a 'constructor' called after the object
+ is created/loaded from the db
+
+
+
+
+ copy all equally named attribute values from the source object to the destination object
+
+
+
+
+
+
+ Returns an index for every instance of this type. Providing this property in a subclass prevents
+ defining via the database
+
+
+
+
+ Returns an index for every instance of this type. Providing this property in a subclass prevents
+ defining via the database
+
+
+
+
+ This method is used to flush an existing Entity and reuse it.
+
+ This method has not been tested
+
+
+
+ Returns all the 'active' affiliations
+
+
+
+
+
+ Removes all this EntityContainer's Affiliations
+
+
+
+
+ Removes all the Affiliations of the given type
+
+
+
+
+ Removes this child from it's Affiliation
+
+
+
+
+
+ Returns if this EntityContainer contains any child 'active' objects
+
+
+
+
+
+ Gets the AffiliationDefinition for the given parent and child types
+
+ The parent object type
+ The child object type
+ An AffiliationDefinition if found, otherwise throws an exception
+
+
+
+ Gets the AffiliationDefinition for the given parent and child typeids
+
+ The object typeId of the parent object
+ The object typeId of the child object
+ An AffiliationDefinition if found, otherwise throws an exception
+
+
+
+ Gets the AffiliationDefinition for the given parent and child types
+
+ The parent object type
+ The child object type
+ bool indicating whether to throw an exception if a definition cannot be found
+ An AffiliationDefinition if found, null if not found, depending on the value of throwError
+
+
+
+ Gets the AffiliationDefinition for the given parent and child typeids
+
+ The object typeId of the parent object
+ The object typeId of the child object
+ bool indicating whether to throw an exception if a definition cannot be found
+ An AffiliationDefinition if found, null if not found, depending on the value of throwError
+
+
+
+ This represents a Role in Engage (PartyRole) table.
+
+
+
+
+ This object represents a User of the system which is a PartyUser and/or a ASPNET_USER row
+
+
+
+
+ Used only on web, no logged in user
+
+
+
+
+ Summary description for CacheEntry.
+
+
+
+
+ This implementation provides default caching using a hashtable as the dictionary
+
+
+
+
+ This interface is implemented by classes that provide caching.
+
+
+
+
+ This implementation provides caching using the web System.Web.Caching.Cache class
+
+
+
+
+ This implementation provides no caching
+
+
+
+
+ This interface is implemented by objects that are null implementions of the 'real' objects
+ It can then be used to test if this is a real or null implementation, in case some different
+ behavior is required when the null object is encountered
+
+
+
+
+ This implementation provides caching using the web System.Web.Caching.Cache class
+
+
+
+
+ Indicates the condition parameter of the assertion method.
+ The method itself should be marked by attribute.
+ The mandatory argument of the attribute is the assertion type.
+
+
+
+
+
+ Initializes new instance of AssertionConditionAttribute
+
+ Specifies condition type
+
+
+
+ Gets condition type
+
+
+
+
+ Specifies assertion type. If the assertion method argument satisifes the condition, then the execution continues.
+ Otherwise, execution is assumed to be halted
+
+
+
+
+ Indicates that the marked parameter should be evaluated to true
+
+
+
+
+ Indicates that the marked parameter should be evaluated to false
+
+
+
+
+ Indicates that the marked parameter should be evaluated to null value
+
+
+
+
+ Indicates that the marked parameter should be evaluated to not null value
+
+
+
+
+ Indicates that the marked method is assertion method, i.e. it halts control flow if one of the conditions is satisfied.
+ To set the condition, mark one of the parameters with attribute
+
+
+
+
+
+ When applied to target attribute, specifies a requirement for any type which is marked with
+ target attribute to implement or inherit specific type or types
+
+
+
+ [BaseTypeRequired(typeof(IComponent)] // Specify requirement
+ public class ComponentAttribute : Attribute
+ {}
+
+ [Component] // ComponentAttribute requires implementing IComponent interface
+ public class MyComponent : IComponent
+ {}
+
+
+
+
+
+ Initializes new instance of BaseTypeRequiredAttribute
+
+ Specifies which types are required
+
+
+
+ Gets enumerations of specified base types
+
+
+
+
+ Indicates that the value of marked element could be null sometimes, so the check for null is necessary before its usage
+
+
+
+
+ Indicates that the value of marked type (or its derivatives) cannot be compared using '==' or '!=' operators.
+ There is only exception to compare with null, it is permitted
+
+
+
+
+ Indicates that method doesn't contain observable side effects.
+ The same as System.Diagnostics.Contracts.PureAttribute
+
+
+
+
+ Tells code analysis engine if the parameter is completely handled when the invoked method is on stack.
+ If the parameter is delegate, indicates that delegate is executed while the method is executed.
+ If the parameter is enumerable, indicates that it is enumerated while the method is executed.
+
+
+
+
+ This attribute is intended to mark publicly available API which should not be removed and so is treated as used.
+
+
+
+
+ Specify what is considered used implicitly when marked with or
+
+
+
+
+ Members of entity marked with attribute are considered used
+
+
+
+
+ Entity marked with attribute and all its members considered used
+
+
+
+
+ Only entity marked with attribute considered used
+
+
+
+
+ Indicates implicit assignment to a member
+
+
+
+
+ Indicates implicit instantiation of a type with fixed constructor signature.
+ That means any unused constructor parameters won't be reported as such.
+
+
+
+
+ Indicates implicit instantiation of a type
+
+
+
+
+ Indicates that the function argument should be string literal and match one of the parameters of the caller function.
+ For example, has such parameter.
+
+
+
+
+ Indicates that marked element should be localized or not.
+
+
+
+
+ Initializes a new instance of the class.
+
+ true if a element should be localized; otherwise, false.
+
+
+
+ Returns whether the value of the given object is equal to the current .
+
+ The object to test the value equality of.
+
+ true if the value of the given object is equal to that of the current; otherwise, false.
+
+
+
+
+ Returns the hash code for this instance.
+
+ A hash code for the current .
+
+
+
+ Gets a value indicating whether a element should be localized.
+ true if a element should be localized; otherwise, false.
+
+
+
+
+ Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes as unused (as well as by other usage inspections)
+
+
+
+
+ Gets value indicating what is meant to be used
+
+
+
+
+ Indicates that the value of marked element could never be null
+
+
+
+
+ Indicates that marked method builds string by format pattern and (optional) arguments.
+ Parameter, which contains format string, should be given in constructor.
+ The format string should be in -like form
+
+
+
+
+ Initializes new instance of StringFormatMethodAttribute
+
+ Specifies which parameter of an annotated method should be treated as format-string
+
+
+
+ Gets format parameter name
+
+
+
+
+ Indicates that the marked method unconditionally terminates control flow execution.
+ For example, it could unconditionally throw exception
+
+
+
+
+ Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library),
+ so this symbol will not be marked as unused (as well as by other usage inspections)
+
+
+
+
+ Gets value indicating what is meant to be used
+
+
+
+
+ This class represents the definition of an Email created by a user.
+
+
+
+
+ This class is provided so that it may be subclassed with a specific implementation such as
+ EmailEvent.
+
+
+
+
+ This method inspects the Engage_Approval table to see if a) there are any approvals there if not
+ the default is approved or true and b) if there are records loop through and inspect the approved
+ flag for a false. If none found true is returned.
+
+
+
+
+ If there's an error communicating with the database
+
+
+
+ An outgoing email routing transaction.
+
+
+
+
+ This class represents affectively, a row in Engage_RoutingTransaction that is runnable or needs an action taken.
+
+
+
+
+ Reference to the service who invoked this service event.
+
+
+
+
+ Initializes a new instance of the class.
+
+ The manager.
+ The current routing transction.
+
+
+
+ Gets all the runnable service events.
+
+ The manager.
+ A list of runnable services.
+
+
+
+ Gets the runnable service events for a given type.
+
+ The manager.
+ The routing event type id.
+ A list of runnable services.
+ If there is an error communicating with the database
+
+
+
+ Runs the specified revising user.
+
+ The revising user.
+
+
+
+ Gets the transaction.
+
+ The transaction.
+
+
+
+ Gets the service manager.
+
+ The service manager.
+
+
+
+ Initializes a new instance of the class.
+
+ The manager.
+ The transaction.
+
+
+
+ Determines whether the specified email address is undeliverable.
+
+ The email address.
+
+ true if the specified email address is undeliverable; otherwise, false.
+
+
+
+
+
+
+
+
+ spInsertEmailEvent
+
+
+
+ Determines whether [is valid to send].
+
+
+ true if [is valid to send]; otherwise, false.
+
+
+
+
+ Sends the email.
+
+
+
+
+ Gets the message body.
+
+
+
+
+ This method should be used to replace merge field values with the
+ This is useful so any concrete client implementations do not need to worry
+ about the underlying HTML and text body (and any other future implementations).
+
+
+
+
+
+ If an error occurs while communicating with the database
+
+
+
+ Gets the license string.
+
+
+
+
+
+ Loads the email license.
+
+
+
+
+ Initializes this instance.
+
+
+
+
+ Handles the BeforeSmtpSend event of the Email control.
+
+ The source of the event.
+ The instance containing the event data.
+
+
+
+ Merges this instance.
+
+
+
+
+ Gets or sets the revising user.
+
+ The revising user.
+
+
+
+ Gets or sets the message body.
+
+ The message body.
+
+
+
+ Gets the event id.
+
+ The event id.
+
+
+
+ Gets the event date.
+
+ The event date.
+
+
+
+ Summary description for ConsoleNode.
+
+
+
+
+ Summary description for IConsoleNode.
+
+
+
+
+ Summary description for DebugTab.
+
+
+
+
+ Summary description for PropertyTab.
+
+
+
+
+ Required designer variable.
+
+
+
+
+ Clean up any resources being used.
+
+
+
+
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+
+
+
+
+ Clean up any resources being used.
+
+
+
+
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+
+
+
+
+ Summary description for DefaultConsoleNode.
+
+
+
+
+ Summary description for DragDataObject.
+
+
+
+
+ Summary description for IExplorerBarSnapin.
+
+
+
+
+ Summary description for IExplorerBarSnapin.
+
+
+
+
+ Summary description for IExplorerSnapin.
+
+
+
+
+ Summary description for ISnapInView.
+
+
+
+
+ Summary description for NullConsoleNode.
+
+
+
+
+ This is a base abstract class used for building new SnapIns.
+
+
+
+
+ Handles the transformation of a provider section in the configuration file into a object.
+
+
+
+
+ Creates a provider configuration.
+
+ The provider section from the configuration file.
+ The created provider configuration object.
+
+
+
+ Creates a configuration section handler.
+
+ Parent object.
+ Configuration context object.
+ Section XML node.
+ The created section handler object.
+
+
+
+ Provides access to an implementation-specific sub-class of (always currently).
+
+
+
+
+ The current instance of this .
+
+
+
+
+ Gets the current instance of this .
+
+ The current instance of .
+
+
+
+ An exception to be thrown on behalf of the data source.
+
+
+
+
+ Concrete implementation of for SQL Server 2000+.
+
+
+
+
+ Initializes a new instance of the class.
+
+ [SiteSqlServer] key not found in config file
+ Application is a web site but configuration file (web.config) cannot be found
+
+
+ if there is an error retrieving the primary key column from the database
+
+
+
+
+
+
+
+
+ An error occurs while communicating with the database
+
+
+ rows affected == 0
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ Could not update entity type
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ Unable to update EntityAffiliationDefinition
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+ An error occurs while communicating with the database
+
+
+
+ This object represents a relationship between two DbObjectContainers.
+ It contains the 'other' EntityContainer and the AffiliationType
+
+
+
+
+ Initializes a new instance of the class.
+
+ The ad.
+ The parent id.
+ The child.
+
+
+
+ Summary description for AffiliationDefinition.
+
+
+
+
+
+ Summary description for AffiliationManager.
+
+
+
+
+ Summary description for EngageDbUtil.
+
+
+
+
+ Determines if the given objectTypeID is a Role
+
+ The objectTypeID to search
+ A bool indicating if the objectTypeID represents a Role
+
+
+
+ Inserts a new row into lkpAttribute
+
+ AttributeTypeID, foreign key from lkpAttributeType
+ sDesc, must be unique value in this table
+ The AttributeID of the new row
+
+
+
+ I added this to allow you to get lookup items from any table in order to
+ use this you must pass in the columns in the following order:
+ 1. IdentityColumn
+ 2. ShortDescription
+ 3. LongDescription
+
+
+
+
+
+
+
+ This method returns an Lookup array of all classes that are type Proxy.
+
+
+
+
+
+ Summary description for NoRecordsFoundException.
+
+
+
+
+ This method is used internally to set the value of this EntityAttribute
+ without triggering the notifications. Used primarily when loading this object
+ from the database 'mbLoading'
+
+ The value to set
+
+
+
+ This method is used to set if this EntityAttribute should be displayed in the
+ Engage.Db.DataFinder/DataFindViewer object(s).
+ Used internally when this EntityAttribute is constructed
+
+
+
+
+
+ This method is used to determine if this EntityAttribute should be displayed in the
+ etg DataFinder/DataFindViewer object(s) as a searchable attribute
+
+
+
+
+ Summary description for EntityInUseException.
+
+
+
+
+
+
+
+
+
+
+ The defaults are: AttributeTypeID = AttributeType.entity.GetId() and DefinitionRequirement = DefinitionRequirement.Required.GetId()
+ the ClassId is either DefaultEntityAttribute or LookupAttribute based on whether the LookupTypeId > 1.
+
+
+
+
+
+
+
+ Summary description for EntityDefinition.
+
+
+
+
+ Summary description for IEntityDefinition.
+
+
+
+
+ Create a copy of the instance of this class.
+
+ Shallow copy only creates a real copy of this instance of the class and contains references
+ to any attributes and child objects. Deep copy creates copies of the instance, all attributes and child objects.
+
+ Shallow copy only creates a real copy of this instance of the class and contains references
+ to any attributes and child objects. Deep copy creates copies of the instance, all attributes and child objects.
+
+
+
+ Use this method to automatically create all the default attributes for this objecttype.
+
+
+
+
+
+
+
+
+
+ Create a copy of the instance of this class.
+
+ Shallow copy only creates a real copy of this instance of the class and contains references
+ to any attributes and child objects. Deep copy creates copies of the instance, all attributes and child objects.
+
+ Shallow copy only creates a real copy of this instance of the class and contains references
+ to any attributes and child objects. Deep copy creates copies of the instance, all attributes and child objects.
+
+
+
+ This method creates a new definition based on an this one without attributes.
+
+
+
+
+
+ Returns an index for every instance of this type. Providing this property in a subclass prevents
+ defining via the database
+
+
+
+
+ Is this instance a newly created object, not belonging to the database
+
+
+
+
+ This object represents a relationship between two DbObjectDefintions.
+ It contains the 'other' EntityContainer and the AffiliationType
+
+
+
+
+ Summary description for DefinitionConsoleNode.
+
+
+
+
+ Summary description for IDefinitionConsoleNode.
+
+
+
+
+ This method is used internally to set the value of this EntityAttribute
+ without triggering the notifications. Used primarily when loading this object
+ from the database 'mbLoading'
+
+ The value to set
+
+
+
+ This method is used to set if this EntityAttribute should be displayed in the
+ Engage.Db.DataFinder/DataFindViewer object(s).
+ Used internally when this EntityAttribute is constructed
+
+
+
+
+
+ This method is used to determine if this EntityAttribute should be displayed in the
+ etg DataFinder/DataFindViewer object(s) as a searchable attribute
+
+
+
+
+ Summary description for Framework.
+
+
+
+
+ Initialize the Framework's caching mechanism not to cache
+ call in global.asax Application_Start
+
+
+
+
+ Initialize the Framework's caching mechanizm for 'web' operation, ie:Browser front end, web site
+ All caches are located in each user HttpSession
+ call in global.asax Application_Start
+
+
+
+
+
+
+ Cleanup methods, normally called by Garbage collector threads
+
+
+
+
+ Clears all caches within the Framework
+
+
+
+
+ Initialize the Framework for 'normal' operation, ie:Windows client front end
+ call in the Main of the application
+
+
+
+
+
+ Initialize the Framework for 'web' operation, ie:Browser front end, web site
+ call in global.asax Session_Start
+ UserStorage located in HttpSessionState
+
+
+
+
+
+
+ For saving and individual object
+
+
+
+
+ Framwework Data Context
+
+
+
+
+ Initializes a new instance of the class.
+
+
+
+
+ Gets an instance of the .
+
+ The instance.
+
+
+
+ Summary description for LookupType.
+
+
+
+
+ Used to initialize a 'group' of EngageType subclass objects
+
+
+ The name of the table from where these type will originate
+
+
+
+ Used to initialize an instance of the given EngageType
+
+ Primary key of this object
+ ShortDescription of this object
+
+
+
+ Used to initialize an instance of the given EngageType
+ This constructor is used for initializing values from Lookup by
+ specifying a LookupType
+
+ The desc.
+ Name of the table.
+ Type of the lookup.
+
+
+
+ Initializes a new instance of the class.
+
+ The description.
+
+
+
+ This class represents a row in Engage_RoutingTransaction and can be extended to provide custom implementations
+ such as EmailRoutingTransaction to do specific tasks.
+
+
+
+
+ Inserts the routing transaction detail.
+
+ The routing transaction id.
+ if set to true [success].
+ The description.
+ The created by.
+
+
+
+ Completes the transaction.
+
+ The revising user.
+
+
+
+ Completes the transaction.
+
+ The description.
+ if set to true [success].
+ The created by Id.
+
+
+
+ Deletes the transaction details.
+
+
+
+
+ Gets or sets any additional data into a template.
+
+ The template.
+
+
+ A general-purpose 3-dimensional vector with floating point components.
+
+
+ Initializes a new instance of the class.
+
+
+ Initializes a new instance of the class.
+ The initial X component.
+ The initial Y component.
+ The initial Z component.
+
+
+ The binary add operator.
+ The first operand.
+ The second operand.
+ The vector sum of the two operands.
+
+
+ The binary difference operator.
+ The first operand.
+ The second operand.
+ The vector difference of the two operands.
+
+
+ Get the hash code for this object.
+ An .
+
+
+ The equality operator.
+ The vector to compare this to.
+ true if this is equivalent to .
+
+
+ Gets or sets the X component.
+
+
+ Gets or sets the Y component.
+
+
+ Gets or sets the Z component.
+
+
+ Gets the magnitude squared.
+
+
+ Gets the magnitude.
+
+
+ Gets the Manhattan/rectilinear magnitude.
+
+
+ Extension methods on
+
+
+
+ At this absolute offset (# of bytes) into a bitmap file,
+ expect to find a 4-byte value which gives
+ the absolute offset to the first byte of raw pixel data.
+
+
+
+ Read all raw pixel values from this image.
+ The image.
+ A sequence of .
+
+
+ Get a histogram of all colors in the image.
+ The image.
+
+ A pixel must have at least this opaqueness to be included.
+ Value is in [0,1], 0 being fully transparent.
+
+ The .
+
+
+ A general histogram of color values.
+
+
+ A mapping of color value to number of occurrences or frequency.
+
+
+ Initializes a new instance of the class.
+
+
+ Initializes a new instance of the class.
+ The data with which to populate this histogram.
+
+
+ Initializes a new instance of the class.
+ An existing histogram to copy values from.
+
+
+ Initializes a new instance of the class.
+ The existing color-tally values to use.
+
+
+ Increment the quantity of a given color.
+ The color.
+
+
+ Get the quantity of a certain color.
+ The color.
+ The quantity as .
+
+
+
+ Reduce this set of colors to a certain maximum size by
+ finding similar colors and dropping the least common ones.
+
+ The maximum number of colors to keep.
+
+
+
+ Create a new histogram which is a subset of this one.
+ Keep only the most common colors.
+
+ The maximum number of colors in the new histogram.
+ A new .
+
+
+
+ Create a new histogram which is a subset of this one. Rather than take strictly the
+ most common colors, maintain some diversity of the color set.
+
+ The maximum number of colors in the new histogram.
+ A new .
+
+
+ Get all colors in the histogram in order from most well-represented to most rare.
+ An ordered sequence of
+
+
+ Remove the least common color values; keep only a certain number of the most common distinct values.
+ The number of distinct colors to maintain in the collection.
+
+
+
+ Flip the key-value relationship of the histogram data,
+ producing for each distinct quantity of pixels a list
+ of the colors which appear that number of times.
+
+ A set of lists of ordered by length.
+
+
+ Gets all the distinct colors represented here.
+
+
+ Gets the number of distinct colors of any quantity.
+
+
+ Gets all colors and their quantities.
+
+
+
+ An immutable 32-bit RGBA color value.
+ This class is a simple and _fast_ alternative to the .Net framework's
+ own color class. Time efficiency is prioritized over
+ extensive feature sets, and values which may or may not
+ be used are calculated lazily wherever possible.
+
+ Note that the alpha value is ignored by many of this class's methods.
+
+
+ The value square root of 3 divided by 2.
+ This is kept as a constant value to avoid (re)calculating square roots.
+
+
+ The red component.
+
+
+ The green component.
+
+
+ The blue component.
+
+
+ The alpha (transparency) value.
+ 0 = transparent, 0xff = opaque
+
+
+
+ The pre-calculated value for .
+ This value is in fact unique to each distinct RGB value.
+
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Backing for
+
+
+ Initializes a new instance of the class.
+ A sequence of four bytes representing B, G, R, A in order.
+
+ This pixel format is what is expected from
+ a raw bitmap image file stream with the 32-bit ARGB format.
+
+
+
+ Gets the Euclidean distance squared between two colors as 3-dimensional points.
+ A .
+ Another .
+ The distance squared between the colors in rectangular RGB space.
+
+
+ Calculate rectilinear distance between two colors as 3-dimensional points.
+ A .
+ Another .
+ The sum of the differences of the three color component values.
+
+
+ Calculate distance squared between two colors as they are positioned in the HSV cone.
+ A .
+ Another .
+
+ The distance squared between the two colors in their proper places in
+ the HSV cone within rectangular 3D space.
+
+
+
+ Calculate distance squared between two colors as they are positioned in the HSL bicone.
+ A .
+ Another .
+
+ The distance squared between the two colors in their proper places in
+ the HSL bicone within rectangular 3D space.
+
+
+
+ Get the hash code for this object.
+ An unique to this color (alpha excluded).
+
+
+ The equality operator.
+ The color to compare this to.
+ true if this is equivalent to (alpha excluded).
+
+
+ Calculate the 8-bit reduced color value.
+ This color value reduced to 3-3-2 bits.
+
+
+ Calculate this color's HSL bicone rectangular coordinate.
+ A .
+
+
+ Gets the HTML hex code for this color (alpha excluded).
+
+
+ Gets the red value translated to the range [0,1].
+
+
+ Gets the green value translated to the range [0,1].
+
+
+ Gets the blue value translated to the range [0,1].
+
+
+ Gets the alpha value translated to the range [0,1].
+
+
+ Gets the maximum value among the three component unit values.
+
+
+ Gets the minimum value among the three component unit values.
+
+
+ Gets the rectangular space location of this color in the HSL bicone.
+
+ The RGB-HSL mapping used here produces a bicone such that:
+ full-black and full-white appear at the two opposing points
+ all fully-saturated colors appear around the circular edge
+ height (black to white) = 0.5
+ radius (grey to saturated) = sqrt(3)/2
+
+
+
+ Gets the x-coordinate of this color in rectangular 3D space within the HSV cone.
+
+
+ Gets the y-coordinate of this color in rectangular 3D space within the HSV cone.
+
+
+ Gets the z-coordinate of this color in rectangular 3D space within the HSV cone.
+
+
+
+ Gets the color in RGB332 format.
+ The 8 bits of the byte are 3 bits red, 3 bits green, and 2 bits blue concatenated.
+
+
+
+ Gets the HSV space conversion alpha factor.
+
+ For information on the alpha and beta factors and their meanings, refer to:
+ http://en.wikipedia.org/wiki/HSL_and_HSV#Hue_and_chroma May 2013
+
+
+
+ Gets the HSV space conversion beta factor.
+
+
+
+ An efficiently searchable "set of intervals".
+ Essentially this is like a single interval which may have any number of
+ endpoints and thus multiple distinct regions of inclusion and exclusion.
+
+
+ This class is _not_ intended to aggregate many fully-defined simple intervals.
+ It does _not_ provide methods for determining which simple interval(s) a query
+ intersects; it can only report whether a query does or does not intersect _any_
+ included region.
+
+ The type of the interval endpoint values and query values.
+
+
+ The points of interest of this interval.
+
+ The number of items in this list will always be a multiple of two.
+ The items in this list, in order, follow a strict lower-upper-lower-upper bound pattern.
+
+
+
+ The smallest interval which includes all subintervals here.
+
+
+ Initializes a new instance of the class.
+
+ A default/empty instance of this class includes no values (-infinity to infinity is excluded).
+
+
+
+ Initializes a new instance of the class.
+ The interval to copy.
+
+
+ Initializes a new instance of the class.
+ The raw subinterval endpoints to use.
+
+
+ Merge several intervals into a union.
+ The intervals to combine.
+ A new interval which covers all values covered by any in the set of sources.
+
+
+ Determine whether there is any overlap amongst a set of intervals.
+ The intervals to test against each other.
+ true if there is any overlap between any two intervals
+
+ For this method all endpoints are taken as open, in other words,
+ overlaps of length zero are considered not overlapping.
+
+
+
+ Include a new range in the set.
+ The interval to include.
+
+ This method is most efficient when including non-overlapping
+ intervals greater than the current upper bound.
+
+
+
+ Test whether a point is within any part of this interval.
+ The point to test.
+ Whether to consider subinterval endpoints closed.
+ true if the point is contained by this
+
+
+ Test for any overlap between this and a simple interval.
+ The interval to test.
+ true if the given interval overlaps this one in any way.
+
+ For this method all endpoints are taken as open, in other words,
+ overlaps of length zero are considered not overlapping.
+
+
+
+ Test for any overlap between this and another compound interval.
+ The other interval to test against.
+ true if the given interval overlaps this one in any way.
+
+ For this method all endpoints are taken as open, in other words,
+ overlaps of length zero are considered not overlapping.
+
+
+
+ Produce a minimal sequence of intervals covering all values this object covers.
+ A sequence of intervals.
+ Note that these may or may not be identical to the intervals originally inserted here.
+
+
+ Update this.pointsSorted, if needed, to include a given interval.
+
+ The interval to include.
+ This method assumes that at least one of this interval's
+ endpoints is strictly inside the current tight bound.
+ Also note, the tight bound is not updated here.
+
+
+
+ Gets a value indicating whether any subintervals are defined.
+
+
+ Gets the number of disjoint subintervals.
+
+
+ Gets the sequence of subinterval endpoints describing this interval.
+
+
+ Gets a sequence of two subinterval endpoints describing this interval's maximum extents.
+
+
+ A class to assist in ordering a mixed collection of points.
+
+
+ Initializes a new instance of the class.
+ The value.
+ If true, this point is a lower bound.
+
+
+ Prevents a default instance of the class from being created.
+
+
+ Compare this to another point.
+ The other point.
+ Negative if other belongs after / is "greater than" this.
+
+
+
+ Examine a sequence of points in order and determine whether any
+ subinterval opens within another.
+ The points to test.
+ true if there is any redundant lower bound.
+
+
+ Gets the value / position of this point.
+
+
+ Gets a value indicating whether this is a lower bound.
+
+
+ A simple numeric interval which can be tested against points and other intervals.
+ The type of the interval endpoint values and query values.
+
+
+ Initializes a new instance of the class.
+ One limit of the interval.
+ The other limit of the interval.
+ Order of arguments is irrelevant.
+
+
+ Initializes a new instance of the class.
+ The interval to copy.
+
+
+ Enlarge this interval if needed to include another interval completely.
+ The other interval.
+
+
+ Determine whether a point is inside this interval.
+ The point.
+ If true, consider the minimum bound inside the interval.
+ If true, consider the maximum bound inside the interval.
+ true if the point is within this interval.
+
+
+ Determine whether this interval overlaps another.
+ The other interval.
+
+ If true, consider the cases of "touching" endpoints (overlap length = 0) to be overlapping.
+
+ true if the two intervals overlap.
+
+
+ Test for equality with another interval.
+ The interval to compare this to.
+ true if this and other are identical.
+
+
+ Gets the minimum limit of the interval.
+
+
+ Gets the maximum limit of the interval.
+
+
+ Gets the minimum and maximum bounds as a sequence.
+
+
+ Gets a value indicating whether this interval includes any range.
+
+
+ Take numerical values one at a time and track how many consecutive values are identical.
+
+
+ maximum deviation from base value of current run
+
+
+ base value of the current run
+
+
+ Initializes a new instance of the class.
+ Maximum difference between two "identical" values.
+
+
+ Initializes a new instance of the class.
+
+
+ Consider next value and determine run length.
+ The value.
+ Number of consecutive values identical to x.
+
+
+ Gets current run length.
+
+
+ A collection of values and various statistical properties of them.
+
+
+ the values
+
+
+ minimum value
+
+
+ maximum value
+
+
+ maximum - minimum
+
+
+ sum of all values
+
+
+ sum of absolute values
+
+
+ mean over all values
+
+
+ variance over all values
+
+
+ standard deviation
+
+
+ Initializes a new instance of the class.
+
+
+ Initializes a new instance of the class.
+ initial population of doubles
+
+
+ Initializes a new instance of the class.
+ initial population of ints
+
+
+ add a value
+ the value
+
+
+ discard all stats
+
+
+ discard mean, variance, standard deviation
+
+
+ Gets minimum.
+
+
+ Gets maximum.
+
+
+ Gets range.
+
+
+ Gets sum.
+
+
+ Gets sum of absolute values.
+
+
+ Gets mean.
+
+
+ Gets variance.
+
+
+ Gets standard deviation.
+
+
+
+ Summary description for RuntimeEnvironmentsSectionHandler.
+
+
+
+
+ Interface implemented by Engage Service to access any service level information.
+
+
+
+
+ Sends the using information configured in the services app.config file.
+
+ The subject of the email message.
+ The body of the email message.
+
+
+
+ Provides a mechanism so that the caller can receive messages of importance and log it if desired.
+
+ The message.
+
+
+
+ Summary description for RoutingEventType.
+
+
+
+
+ This class handles the processing of RoutingTransactions records. RunServiceEvents provides a way to run
+ all Routing Event types or a specific type. Any unhandled exceptions are sent to alerts@engageemail.com
+ for review.
+
+
+
+
+ Runs the service events.
+
+ The manager.
+ The routing event type id.
+ The revising user.
+
+
+
+ Runs the service events.
+
+ The manager.
+ The revising user.
+
+
+
+ Runs the service events.
+
+ The manager.
+ The type.
+ The revising user.
+
+
+
+ Runs the transactions.
+
+ The transactions.
+ The revising user.
+
+
+
+ Sends the notification.
+
+ The error.
+
+
+
+ Gets a singleton instance of the RoutingManager.
+
+ The instance.
+
+
+
+ Gets the max routing events per cycle.
+
+ The max routing events per cycle.
+
+
+
+ This class represents a row in Engage_RoutingTransactionDetail with details about the transaction results.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents a single attribute of a .
+
+
+
+
+ Initializes a new instance of the Attribute class
+ with the specified that the attribute belongs to.
+
+ to which the newly created Attribute belongs to.
+
+
+
+ Sets the flag to true.
+
+
+
+
+ Gets string representation of the attribute.
+
+ Entire attribute text ().
+
+
+
+ Gets the to which this attribute belongs.
+
+
+ The to which this attribute belongs.
+
+
+
+
+ Gets the that the Atrribute belongs to.
+
+
+ The that the Atrribute belongs to.
+
+
+
+
+ Gets the entire body of the Attribute.
+
+
+ The entire body of the Attribute.
+ For example, Body is id="Label1" for the attribute id="Label1".
+
+
+
+
+ Gets that
+ represents of this tag.
+
+
+ representing entire body of this tag ().
+
+
+
+
+ Gets the key of the attribute.
+
+
+ The key of the attribute.
+ For example, Key is id for the attribute id="Label1".
+
+
+
+
+ Gets that
+ represents of this tag.
+
+
+ representing key of this tag ().
+
+
+
+
+ Gets the value of the attribute.
+
+
+ The value of the attribute.
+ For example, Value is Label1 for the attribute id="Label1".
+
+
+
+
+ Gets that
+ represents of this tag.
+
+
+ representing value of this tag ().
+
+
+
+
+ Gets value indicating whether the attribute is databound.
+
+
+ true if the attribute is databound; otherwise, false.
+ For example, DataBound is true for the attribute Text='<% this.ReturnText() %>'.
+
+
+
+
+ Represents a list of attributes that can be accessed by key or index.
+
+
+
+
+ Initializes a new instance of the AttributeList class.
+ The list is initialy empty.
+
+
+
+
+ Provides support for the "foreach" style iteration over the lis of attributes in the AttributeList.
+
+ An .
+
+
+
+ Appends specified at the end of the list.
+
+ The to append.
+
+
+
+ Gets the attribute with the specified key.
+
+ The key of the attribute.
+
+ The with the specified key.
+
+
+
+
+ Gets the attribute with the specified index.
+
+ The index of the attribute.
+
+ The with the specified index.
+
+
+
+
+ Gets the number of attributes in the list.
+
+
+ The number of attributes.
+
+
+
+
+ Represents fragment of defined by index and length
+ in the parent document.
+
+
+
+
+ Initializes a new instance of the DocumentFragment class
+ with the specified that the fragment belongs to.
+
+ to which the newly created fragment belongs to.
+
+
+
+ Defines index and length of the fragment in the document.
+
+ Index at which the fragment occurs in document.
+ Length of the fragment in document.
+
+ Index must be greater or equal to zero
+ Index cannot exceed document length or
+ Length must be greater or equal to zero or
+ Index plus length cannot exceed document length
+
+
+
+
+ Gets the to which this fragment belongs.
+
+
+ The to which this fragment belongs.
+
+
+
+
+ Gets index of the fragment in document.
+
+
+ Index of the fragment in document.
+
+
+
+
+ Gets length of the fragment in document.
+
+
+ Length of the fragment in document.
+
+
+
+
+ Gets the line number of the fragment in document.
+
+
+ The line number of the fragment in document.
+
+
+
+
+ Gets the column number of the fragment in document.
+
+
+ The line column of the fragment in document.
+
+
+
+
+ Gets the text of the fragment.
+
+
+ The text of the fragment.
+
+ Index and length not defined.
+
+
+
+ Gets value indicating whether the fragment is defined.
+
+
+ true if the fragment is defined; otherwise, false.
+
+
+
+
+ Represents a single Engage tag in a template document.
+
+
+
+
+ Represents a single tag in the ASPX document.
+
+
+
+
+ The list of tags which do not require closing tags
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Initializes static members of the class.
+
+
+
+
+ Initializes a new instance of the class
+ with the specified parent and type.
+
+ Parent of the created tag.
+ Type of the created tag.
+
+
+
+ Determines whether this tag has an attribute with the specified .
+
+ The attribute name.
+
+ true if this tag has an attribute with the specified ; otherwise, false.
+
+
+
+
+ Gets the value of the attribute on this tag with the given .
+
+ The attribute name.
+ The value of the attribute with the given , or null if an attribute with that name does not exist on this tag
+
+
+
+ Gets string representation of the tag.
+
+ Entire tag text ().
+
+
+
+ Sets error to the current tag.
+
+ Error to set.
+
+
+
+ Gets the to which this tag belongs.
+
+ The to which this tag belongs.
+
+
+
+ Gets the parent of this tag.
+
+
+ The Tag that is the parent of the current tag.
+
+
+
+
+ Gets the namespace prefix of this tag.
+
+
+ The namespace prefix of this tag.
+ For example, Prefix is asp for the tag <asp:label>.
+ If there is no prefix, this property returns String.Empty.
+
+
+
+
+ Gets local name of the tag.
+
+
+ The name of the tag with the prefix removed.
+ For example, LocalName is label for the tag <asp:label>.
+
+
+
+
+ Gets the qualified name of the tag.
+
+
+ The qualified name of the tag.
+ For example, Name is asp:label for the tag <asp:label>.
+
+
+
+
+ Gets that
+ represents of this tag.
+
+
+ representing name of this tag ().
+
+
+
+
+ Gets the entire text of this tag.
+
+
+ Entire text of this tag.
+ For example, Value is <asp:label id="Label1"> for the tag <asp:label id="Label1">.
+
+
+
+
+ Gets that
+ represents of this tag.
+
+
+ representing entire text of this tag ().
+
+
+
+
+ Gets an containing the attributes of this tag.
+
+
+ An containing the attributes of the tag.
+
+
+
+
+ Gets all the child tags of the tag.
+
+
+ An that contains all the child tags of the tag.
+
+
+
+
+ Gets a value indicating whether this tag has any child tags.
+
+
+ true if the tag has child tags; otherwise, false.
+
+
+
+
+ Gets the first child of the tag.
+
+
+ The first child of the tag.
+ If there is no such tag, a null reference is returned.
+
+
+
+
+ Gets the last child of the tag.
+
+
+ The last child of the tag.
+ If there is no such tag, a null reference is returned.
+
+
+
+
+ Gets the type of the current tag.
+
+
+ One of the values.
+
+
+
+
+ Gets the error of the current tag.
+
+
+ One of the values.
+
+
+
+
+ Gets a value indicating whether the tag requires to be closed with a close tag.
+
+
+ true if the tag requires to be closed; otherwise, false.
+
+
+
+
+ Specifies error of .
+
+
+
+
+ Specified that there is no error.
+
+
+
+
+ The tag is not closed with a closing tag.
+
+
+
+
+ Close tag occurs without open tag.
+
+
+
+
+ Represents a list of tags that can be accessed by name or index.
+
+
+
+
+ Initializes a new instance of the TagList class.
+ The list is initialy empty.
+
+
+
+
+ Provides support for the "foreach" style iteration over the list of tags in the TagList.
+
+ An .
+
+
+
+ Appends specified at the end of the list.
+
+ The to append.
+
+
+
+ Gets the first tag with the specified qualified .
+
+ The qualified name of the tag to retrieve.
+ The first that matches the specified name.
+
+
+
+ Gets the tag with the specified index.
+
+ The index of the tag.
+
+ The with the specified index.
+
+
+
+
+ Gets the first in the list.
+
+
+ The first in the list.
+
+
+
+
+ Gets the last in the list.
+
+
+ The last in the list.
+
+
+
+
+ Gets the number of tags in the list.
+
+
+ The number of tags.
+
+
+
+
+ Specifies the type of .
+
+
+
+
+ A object that, as the root of the document tree,
+ provides access to the entire Asp document.
+
+
+
+
+ Open tag.
+
+ Example: <asp:label id="Label1">
+
+
+
+
+
+ Close tag.
+
+ Example: </asp:label>
+
+
+
+
+
+ Text tag.
+
+ Example: <title>TEXT</title> - the TEXT will occur as a Text tag
+
+
+
+
+
+ Directive tag.
+
+ Example: <%@ Page language= "c#" %>
+
+
+
+
+
+ Code tag.
+
+ Example: <% this.DoSomething() %>
+
+
+
+
+
+ Comment tag.
+
+ Example: <!-- COMMENTED --> or <%-- COMMENTED --%>
+
+
+
+
+
+ Represents an template document.
+
+
+
+
+ Initializes static members of the class.
+
+
+
+
+ Initializes a new instance of the class
+ with the Aspx document content.
+
+ Name of the doc.
+ The Aspx document content that will be represented by the created object.
+
+
+
+ Gets to which this tag belongs.
+
+
+ This property always returns this reference
+ as the Template Document is always a root.
+
+
+
+
+ Gets the parent of this tag.
+
+
+ This property always returns a null reference
+ as the Document is always a root.
+
+
+
+
+ Gets the namespace prefix of this tag.
+
+
+ This property always returns an empty string (String.Empty)
+ as the Document does not have a Prefix.
+
+
+
+
+ Gets the entire text of the ASP document.
+
+
+ The entire text of the ASP document.
+
+
+
+
+ Gets the entire text of the ASP document.
+
+
+ The entire text of the ASP document.
+
+
+
+
+ Gets that
+ represents of this tag.
+
+
+ representing name of this tag ().
+
+
+
+
+ Gets entire text of the ASP document.
+
+
+ Entire text of this document.
+
+
+
+
+ Gets that
+ represents of this tag.
+
+
+ representing value of this tag ().
+
+
+
+
+ Summary description for IMessageLogger.
+
+
+
+
+ Summary description for IProgressBar.
+
+
+
+
+ Summary description for IProgressBarProvider.
+
+
+
+
+ Enables interaction with the user interface of the development environment object that is hosting the designer.
+
+
+
+
+ Enables interaction with the user interface of the development environment object that is hosting the designer.
+
+
+
+
+ Summary description for IXmlProvider.
+
+
+
+
+ Summary description for DefaultProgressBar.
+
+
+
+
+ A utility class to help with common service related activities.
+
+
+
+
+ Summary description for UserStorage.
+
+
+
+
+ Will break on failed assert statements in ASP.NET applications.
+
+
+ You need to set up a boolean switch in your web.config named "BreakOnAssert" to true in order to enable this.
+ Then wire up this class as a listener.
+ from http://www.c-sharpcorner.com/UploadFile/johnconwell/DebugAssertInASPDotNet11262005013820AM/DebugAssertInASPDotNet.aspx
+
+
+
+
+ When overridden in a derived class, writes the specified message to the listener you create in the derived class.
+
+ A message to write.
+
+
+
+ Writes the value of the object's method to the listener you create when you implement the class.
+
+ An whose fully qualified class name you want to write.
+
+
+
+ Writes a category name and the value of the object's method to the listener you create when you implement the class.
+
+ An whose fully qualified class name you want to write.
+ A category name used to organize the output.
+
+
+
+ Writes a category name and a message to the listener you create when you implement the class.
+
+ A message to write.
+ A category name used to organize the output.
+
+
+
+ When overridden in a derived class, writes a message to the listener you create in the derived class, followed by a line terminator.
+
+ A message to write.
+
+
+
+ Writes the value of the object's method to the listener you create when you implement the class, followed by a line terminator.
+
+ An whose fully qualified class name you want to write.
+
+
+
+ Writes a category name and the value of the object's method to the listener you create when you implement the class, followed by a line terminator.
+
+ An whose fully qualified class name you want to write.
+ A category name used to organize the output.
+
+
+
+ Writes a category name and a message to the listener you create when you implement the class, followed by a line terminator.
+
+ A message to write.
+ A category name used to organize the output.
+
+
+
+ Causes the debugger to break debugging.
+
+
+
+ A one-to-one mapping of integer values.
+
+
+ Mapping of input to output.
+
+
+ Mapping of output to input.
+
+
+ Initializes a new instance of the class.
+
+
+ Initializes a new instance of the class.
+ The values to map, in order.
+ The corresponding values to map to, in order.
+
+
+ Add a single value mapping.
+ The input value.
+ The output value.
+
+
+ Map a value.
+ The value to map.
+ The mapping value.
+
+
+ Map a pair of values.
+ The pair to map.
+ A new with values mapped.
+
+
+ Reverse map a value.
+ The output value to un-map.
+ The input value mapped to this value.
+
+
+
+ A class for getting values of an object's properties and fields (or nested properties) by name.
+
+
+
+
+ Expression which will match invalid property paths.
+
+
+
+ Cache of property path to value.
+
+
+ Paths of properties that are known to be absent.
+
+
+ If true, do case-insensitive property name searches.
+
+
+
+ Initializes a new instance of the class.
+
+ The object on which to search for properties and fields.
+ If true, do case-insensitive property name searches.
+
+
+
+ Try to get a property or field value by name.
+
+ The property name.
+ The object to search for the property.
+ The property's value.
+ If true, do case-insensitive property name matches.
+ true if the property was found.
+
+
+
+ Get the value of a property or field.
+
+
+ The property path.
+ This may be the name of a property on the object or a dot-delimited specification of a nested property.
+
+ The value of the property or field.
+ true if the lookup succeeded.
+
+
+
+ Extend the property cache to include a specified property and its parents.
+
+ The property name or path.
+ true if all properties were found
+
+
+ A collection of combinatorics-related methods.
+ The type of item.
+
+
+ Generate all k-combinations for a set of items.
+ The items to choose from.
+ The number of items to take at a time.
+
+ A sequence of sequences of items.
+ Note that there is no guarantee of certain orderings.
+
+
+
+ Type-independent combinatorics tools.
+
+
+ Generate all k-combinations of the integers in [0,n).
+ The number of numbers to draw from.
+ The number of numbers to take at a time.
+ A sequence of monotonically decreasing sequences of int.
+
+
+ Generate all pairings among some set of values.
+ The values to pair.
+ A sequence of .
+
+
+ An immutable permutation of integers.
+
+
+ All values which appear in the sequence.
+
+
+ The sequence itself.
+
+
+ The hash code of this sequence.
+
+
+ Initializes a new instance of the class.
+ The unique values in order.
+
+
+ Determine whether this and another sequence are permutations of the same set.
+ The other sequence.
+ true if the two are in some permutation group.
+
+
+ Determine whether this and another sequence are identical.
+ The other sequence.
+ true if the two are equivalent.
+
+
+ Get the hash code for this sequence.
+ A value which almost kindasorta uniquely identifies this sequence.
+
+
+
+ An altered that renders within a structure like the the ModuleMessage control with an Error ModuleMessageType.
+
+
+
+
+ Sends server control content to a provided object, which writes the content to be rendered on the client.
+
+ The output stream that renders HTML content to the client.
+
+
+
+ Determines whether the page that this validation summary is on is in error. Use this to determine whether to display markup or not.
+
+
+ We need to use this method because we can't call Page.IsValid until the page has been validated, which it may not have been.
+ If we validate manually, it may throw validation errors before the user submits the page.
+
+
+ true if this control's page in error; otherwise, false.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An interface specifying read-only i.e. query-like operations for simple graphs.
+
+
+ Get any and all vertices directly adjacent to the vertex given.
+ The vertex.
+ A sequence of the vertex's neighbors, if any.
+
+
+ Get all possible maximum matchings.
+ A sequence of vertex pair sets with no repeated vertices.
+
+
+ Gets the number of vertices in the graph.
+
+
+ Gets the number of vertices having no incident edges.
+
+
+ Gets all the vertices.
+
+
+ Gets all the vertices having at least one edge.
+
+
+ Extension methods for manipulating instances
+
+
+ Get the selected value from a .
+ The list control.
+ The selected value.
+ is null
+
+
+ Get the selected value from a .
+ The list control.
+ The selected value or null if none.
+ is null
+
+
+ Set the selected value from a .
+ The list control.
+ The item value to select (select first empty value if null)
+ is null
+
+
+ Get the selected value from a .
+ The list control.
+ The type of the .
+ The selected value.
+ is null
+
+
+ Get the selected value from a .
+ The list control.
+ The type of the .
+ The selected value or null if none.
+ is null
+
+
+ Set the selected value from a .
+ The list control.
+ The value to select (select first empty value if null)
+ The type of the .
+ is null
+
+
+ Set the selected value from a .
+ The list control.
+ The value to select (select first empty value if null)
+ The type of the .
+ is null
+
+
+ Get the selected value from a .
+ The list control.
+ The selected value.
+ is null
+
+
+ Get the selected value from a .
+ The list control.
+ The selected value or null if none.
+ is null
+
+
+ Set the selected value from a .
+ The list control.
+ The item value to select (select first empty value if null)
+ is null
+
+
+ Set the selected value from a .
+ The list control.
+ The item value to select (select first empty value if null)
+ is null
+
+
+ Select one or more values in a and unselect any other items.
+ A list control (which allows multiple selection).
+ The values to select.
+ or are null
+
+
+ Select one or more values in a and unselect any other items.
+ A list control (which allows multiple selection).
+ The values to select.
+ or are null
+
+
+
+ Get all selected values from a .
+ Non-integer values are ignored whether selected or not.
+
+ A list control (which allows multiple selection).
+ A sequence of the selected items' values as values
+ is null
+
+
+
+ Get all selected values from a .
+
+ A list control (which allows multiple selection).
+ A sequence of the selected items' values
+ is null
+
+
+ Marks the given value as a selected value of the .
+ The list control.
+ The value.
+ if set to true match value with exact case; otherwise match insensitive to case.
+
+
+ Sets the given value as the only selected value of the .
+ The list control.
+ The value.
+ if set to true match value with exact case; otherwise match insensitive to case.
+
+
+ Sets the selected value without regard for case.
+ The list control.
+ The value.
+
+
+
+ An object for taking possible pairs of items in order such that
+ some distance-like metric monotonically increases.
+
+
+ The type of the items which will be paired off
+ and then have distances calculated between them.
+
+
+
+ All distinct pairs of points ordered by decreasing distance metric.
+
+
+
+ A quickly-searchable collection of points which are globally discarded.
+ This is used to discard pairings lazily.
+
+
+
+ Initializes a new instance of the class.
+ The points to pair up and queue.
+ The function with which to calculate distance between two points.
+
+
+ Prevents a default instance of the class from being created.
+
+
+ Remove and return the nearest pair of points.
+ A pair of the nearest points.
+
+
+ Discard all pairings involving a given point.
+ The point to discard globally.
+
+
+ A basic function prototype for calculating a metric between two points.
+ The first point.
+ The second point.
+ The value of the metric between the points.
+
+
+ A frame in the pairing queue.
+
+
+ Initializes a new instance of the class.
+ The first point.
+ The second point.
+ The value of the metric between the points.
+
+
+ Gets the first point in the pair of points.
+
+
+ Gets the second point in the pair of points.
+
+
+ Gets the value of the metric between the two points.
+
+
+
+ Extension methods for
+
+
+
+ Formats the value of the current instance using the specified format.
+ The underlying value type of
+ The value for which to get a representation.
+ The format to use -or- null to use the default format defined for the type of the implementation.
+ The provider to use to format the value -or- null to obtain the numeric format information from the current locale setting of the operating system.
+ The value of the current instance in the specified format.
+
+
+ Formats the value of the current instance using the specified format.
+ The underlying value type of
+ The value for which to get a representation.
+ The provider to use to format the value -or- null to obtain the numeric format information from the current locale setting of the operating system.
+ The value of the current instance in the specified format.
+
+
+ Formats the value of the current instance using the specified format.
+ The underlying value type of
+ The value for which to get a representation.
+ The format to use -or- null to use the default format defined for the type of the implementation.
+ The provider to use to format the value -or- null to obtain the numeric format information from the current locale setting of the operating system.
+ The to provide when doesn't have a value.
+ The value of the current instance in the specified format.
+
+
+ Formats the value of the current instance using the specified format.
+ The underlying value type of
+ The value for which to get a representation.
+ The provider to use to format the value -or- null to obtain the numeric format information from the current locale setting of the operating system.
+ The to provide when doesn't have a value.
+ The value of the current instance in the specified format.
+
+
+ An enumerator with a Take()-like limit which can be arbitrarily reset.
+ The type of object being enumerated.
+
+
+ The item source to take from.
+
+
+ The maximum number of additional items to yield.
+
+
+ Initializes a new instance of the class.
+ The items to draw from.
+ The initial maximum number of items to take.
+
+
+ Prevents a default instance of the class from being created.
+
+
+ Allow another items to be taken.
+
+
+ Allow another items to be taken.
+ New value for .
+
+
+ Dispose the source enumerator.
+
+
+ Advance to the next item in the sequence.
+ true if there is a next item.
+
+
+ Reset the source enumerator and renew this limit.
+
+
+ Gets the last limit set.
+
+
+ Gets the current item.
+
+
+ Gets the current item.
+
+
+
+ A simple graph.
+ Undirected edges.
+ No loops (edges from any vertex back to itself).
+ Simple integers are used for vertices.
+
+
+
+ For each vertex, a set of vertices which share an edge with it.
+
+ Every vertex is represented here regardless of number of incident edges
+ i.e. this dictionary's key collection _is_ the vertex collection.
+
+
+
+ The next value to use when creating a new vertex.
+
+
+ Initializes a new instance of the class.
+
+
+ Initializes a new instance of the class.
+ The graph to duplicate.
+
+
+ Initializes a new instance of the class.
+ The graph to duplicate.
+
+
+ Generate a complete graph.
+ The vertices to use.
+ A with all pairs of vertices connected.
+
+
+ Add a new vertex to the graph and return its unique identifier.
+ An unique to the new vertex.
+
+
+ Add a new vertex with a specific value to the graph.
+ The vertex to add.
+
+
+ Remove a vertex and any edges connected to it.
+ The vertex to remove.
+
+
+ Create an edge between two distinct vertices.
+ A vertex.
+ Another vertex.
+
+
+ Create an edge between two distinct vertices.
+ A pair of vertices.
+
+
+ Add edges between every pair in a set of vertices.
+ The vertices to be fully-connected.
+
+
+ Remove an edge between two distinct vertices.
+ A vertex.
+ Another vertex.
+
+
+ Remove an edge between two distinct vertices.
+ A pair of vertices.
+
+
+ Get all matchings of maximum theoretical/optimistic size.
+ A sequence of vertex pair sets with no repeated vertices.
+ This implementation is not good.
+
+
+ Get the number of edges incident to a given vertex.
+ The vertex.
+ The number of vertices adjacent.
+
+
+ Get any and all vertices directly adjacent to the vertex given.
+ The vertex.
+ A sequence of the vertex's neighbors, if any.
+
+
+
+ Iterate over all vertices in some arbitrary order, following
+ edges from one vertex to the next wherever possible.
+ No guarantees about precise order,
+ except that all isolated vertices are returned first.
+
+ A sequence of vertices.
+
+
+
+ Quickly produce a partition of the graph's vertices
+ such that no two in any partition share an edge.
+ In other words, break the graph into disjoint subsets.
+
+
+ A mapping of some arbitrary "color" value to sets of vertices,
+ where each set has all vertices of the same color,
+ no vertex appears in more than one set,
+ and no two vertices within a set are connected by an edge.
+
+
+ This simple algorithm cannot be expected to always produce
+ optimal solutions, but it does in some cases.
+
+
+
+
+ Use "squeaky wheel" optimization to produce a partition of the graph's vertices
+ such that no two in any partition share an edge.
+ In other words, break the graph into disjoint subsets.
+
+
+ A mapping of some arbitrary "color" value to sets of vertices,
+ where each set has all vertices of the same color,
+ no vertex appears in more than one set,
+ and no two vertices within a set are connected by an edge.
+
+
+
+
+ Quickly produce a partition of the graph's vertices
+ such that no two in any partition share an edge.
+ In other words, break the graph into disjoint subsets.
+
+ The to use in traversing the graph.
+
+ A mapping of some arbitrary "color" value to sets of vertices,
+ where each set has all vertices of the same color,
+ no vertex appears in more than one set,
+ and no two vertices within a set are connected by an edge.
+
+
+
+ Generate multiple random colorings and return the best found.
+ The to use in traversing the graph.
+ An ordering of vertices to include in the coloring search.
+
+ A mapping of some arbitrary "color" value to sets of vertices,
+ where each set has all vertices of the same color,
+ no vertex appears in more than one set,
+ and no two vertices within a set are connected by an edge.
+
+
+ This method is guaranteed to return, but its running time
+ is not very consistent. Large graphs with high degree especially
+ may or may not run for long times.
+
+
+
+ Partition the graph's vertices such that no two in any partition share an edge.
+ Vertices to include in the coloring in some order.
+
+ A mapping of some arbitrary "color" value to sets of vertices,
+ where each set has all vertices of the same color,
+ no vertex appears in more than one set,
+ and no two vertices within a set are connected by an edge.
+
+ There should exist some ordering of the vertices which will result in an optimal coloring.
+
+
+ Get the adjacency list for a given vertex.
+ The vertex.
+ The vertex's associated neighbor set.
+
+
+
+ Get almost all possible matchings.
+ All maximum matchings will be produced, some other types may not be.
+
+ A sequence of vertex pair sets with no repeated vertices.
+
+
+ Gets the number of vertices in the graph.
+
+
+ Gets the number of vertices having no incident edges.
+
+
+ Gets the maximum degree over all vertices.
+
+
+ Gets all the vertices.
+
+
+ Gets all the vertices having at least one edge.
+
+
+ Gets the number of edges in the graph.
+
+
+ Extensions to
+
+
+ Expression matching format tokens and ignoring escapes "{{" and "}}" properly.
+
+
+ characters used by string.Format to mark the start of special formatting
+
+
+
+ Returns a value indicating whether the specified object occurs within the string.
+ A parameter specifies the type of search to use for the specified string.
+
+ The string to search in
+ The string to seek
+ One of the enumeration values that specifies the rules for the search
+ or is null
+ is not a valid value
+
+ true if the parameter occurs within the parameter,
+ or if is the empty string ("");
+ otherwise, false.
+
+
+ The parameter specifies to search for the value parameter using the current or invariant culture,
+ using a case-sensitive or case-insensitive search, and using word or ordinal comparison rules.
+
+
+
+
+ Returns a new string in which all occurrences of a specified in string are replaced with another specified string.
+ A parameter specifies the type of search to use for the specified string.
+
+ The string to search in
+ The string to be replaced
+ The string to replace all occurrences of
+ One of the enumeration values that specifies the rules for the search
+ or is null
+ is the empty string ("") or is not a valid value
+
+ A string that is equivalent to string except that all instances of are replaced with .
+ If is not found in string, the method returns string unchanged.
+
+
+ If is null, all occurrences of are removed.
+ The parameter specifies to search for the value parameter using the current or invariant culture,
+ using a case-sensitive or case-insensitive search, and using word or ordinal comparison rules.
+
+
+
+
+ Replace named placeholders in a format string with values.
+
+
+ The format string.
+ Placeholder names are like string.Format, except instead of integer keys "{0}",
+ "{value}"
+ "{value.ValueNameMember}"
+ "{value.Member1.MemberOfMember1}"
+ "{value.ValueNameMember:format}", where "format" is like string.Format.
+ "value" is a name of a member of the "values" parameter.
+ Unmatched and invalid placeholders are left as-is.
+
+ The values.
+ The format string with values substituted.
+
+
+
+ Replace named placeholders in a format string with values.
+
+
+ The format string.
+ Placeholder names are like string.Format, except instead of integer keys "{0}",
+ "{value}"
+ "{value.ValueNameMember}"
+ "{value.Member1.MemberOfMember1}"
+ "{value.ValueNameMember:format}", where "format" is like string.Format.
+ "value" is a name of a member of the "values" parameter.
+ Unmatched and invalid placeholders are left as-is.
+
+ The values.
+ to use for formatting.
+ The format string with values substituted.
+
+
+
+ This class is a concrete implementation of the EngageSessionBase class.
+
+
+
+
+ This abstract class provides a set of methods to manage the static
+ GlobalSession
+ object provided by the subclasses;
+ Some implementation is provided, the others must be implemented by the
+ subclasses. Mainly be because the
+ GlobalSession
+ object
+ is a Singleton and must be provided by the subclasses in order to have
+ multiple instances.
+ Also, synchronization must be implemented by the subclass, on it's
+ Class object
+ @author Mark Gorla - Emerging Technologies Group
+ @version $Revision: 9 $
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Summary description for DefaultEntityAttribute.
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type ID.
+ The lookup type id.
+
+
+
+ Summary description for ICommand.
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Summary description for EngageAffiliationType.
+
+
+
+
+ Summary description for DeleteObjectCommand.
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+
+
+
+
+
+
+ Summary description for EngageAffiliationType.
+
+
+
+
+ Summary description for Attribute.
+
+
+
+
+ Summary description for AttributeType.
+
+
+
+
+ Summary description for LookupType.
+
+
+
+ Extensions to collections
+ Extensions to collections: value ranges generation.
+
+
+ Returns the given as an enumerable sequence.
+ The type of the element.
+ The single item in the sequence.
+ An instance that contains only
+
+
+ Determines whether the specified sequence holds a single element.
+ Implementation based on JaredPar at
+ The type of the elements in
+ The sequence.
+ true if the specified sequence is made up of exactly one element; otherwise, false.
+
+
+ Determines whether the specified sequence holds more than one element.
+ The type of the elements in
+ The sequence.
+ true if the specified sequence is made up of many elements; otherwise, false.
+
+
+ Adds the given to the end of the specified .
+ Implementation from JaredPar at
+ The type of the elements in
+ The sequence to which should be added.
+ The value to add to the .
+ An instance that contains with added to the end
+
+
+ Adds the given to the beginning of the specified .
+ Implementation from JaredPar at
+ The type of the elements in
+ The sequence to which should be added.
+ The value to add to the .
+ An instance that contains with added to the end
+
+
+ Get the most common value occurring in a sequence.
+ The nonempty sequence of values to tally.
+ A value which appears the maximum number of times.
+
+
+ Interleaves the contents of several sequences i.e. take one element from each in turn.
+ The sequences to interleave.
+ type of the items in the input sequences
+ A sequence of
+ is null or has a null sequence
+
+
+
+ Interleave the contents of several sequences and group them.
+ If all source sequences have equal size, the result will resemble a matrix transposition.
+
+ The sequences to transpose.
+ Type of the items in the input sequences
+ A sequence of sequences of
+ is null or has a null sequence
+
+
+ Interleaves the contents of several sequences i.e. take one element from each in turn.
+ The sequences to interleave.
+ Type of the items in the input sequences
+ A sequence of
+
+
+
+ Interleave the contents of several sequences and group them.
+ If all source sequences have equal size, the result will resemble a matrix transposition.
+
+ The sequences to transpose.
+ Type of the items in the input sequences
+ A sequence of sequences of
+
+
+
+ Take one from each given enumerator in order.
+ Remove any exhausted enumerators from the list.
+
+ The enumerators.
+ Type of the items enumerators yield.
+ A sequence of
+
+
+ Generate a sequence of integer values in order from largest to smallest.
+ The final, minimum value which will be yielded.
+ The number of values to yield.
+ A monotonically decreasing sequence of int.
+
+ This method gives basically the same result as:
+ Enumerable.Range(countDownTo, count).Reverse()
+ but it avoids generating and storing the values as Enumerable.Reverse would.
+
+
+
+
+ Generates a sequence of characters within a specified range including the given endpoints.
+ If final is numerically less than first, the sequence will be in decreasing order from first to final.
+
+ The first char in the sequence.
+ The final char in the sequence.
+ A sequence of char
+
+
+
+ Generates a sequence of integers within a specified range including the given endpoints.
+ If final is less than first, the sequence will be in decreasing order from first to final.
+
+ The first value in the sequence.
+ The final value in the sequence.
+ A sequence of int
+
+
+
+ Generates a sequence of integers from starting value to ending value, not including ending value.
+ If end is less than start, the sequence will be in decreasing order from start.
+
+ The first value in the sequence.
+ The exclusive end of the sequence.
+ A sequence of int
+
+
+
+ A comparer that takes a string and sorts by a field of that name on the compared objects.
+ If the field is not , but is ,
+ it will attempt to sort by the first value in the list (assuming that the list isn't empty
+ and the type of enumerated type is .
+ from
+
+ The type of objects to compare.
+
+
+
+ Name of the field by which the items are to be sorted
+
+
+
+
+ Initializes a new instance of the class.
+
+ The name of the field by which the items are to be sorted.
+ The direction in which to sort items.
+
+
+
+ Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.
+
+ The first object to compare.
+ The second object to compare.
+
+ Value
+ Condition
+ Less than zero
+ is less than .
+ Zero
+ equals .
+ Greater than zero
+ is greater than .
+
+
+
+
+ Gets or sets the direction in which to sort items.
+
+ The direction in which to sort items.
+
+
+
+ This class represents an attribute. The is assigned
+ from a validation process, and is used to provide default values.
+
+
+
+
+ Attribute objects are reused during parsing to reduce memory allocations,
+ hence the Reset method.
+
+
+
+
+ Initializes a new instance of the class.
+
+
+
+
+ Returns an enumerator that iterates through a collection.
+
+
+ An object that can be used to iterate through the collection.
+
+
+
+
+ Returns an enumerator that iterates through the collection.
+
+
+ A that can be used to iterate through the collection.
+
+
+
+
+ Gets the with the specified name.
+
+
+
+
+ Attribute type is not supported
+
+
+ Attrivute value is not supported
+
+
+
+ SGML is case insensitive, so here you can choose between converting
+ to lower case or upper case tags. "None" means that the case is left
+ alone, except that end tags will be folded to match the start tags.
+
+
+
+
+ Initializes a new instance of the class.
+
+
+
+ Declared content type is not supported
+
+
+
+ Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+
+
+
+ Invalid name character
+
+
+ SgmlException.
+
+
+ SgmlException.
+
+
+ SgmlException.
+
+
+ SgmlException.
+
+
+
+ Releases unmanaged and - optionally - managed resources
+
+ true to release both managed and unmanaged resources; false to release only unmanaged resources.
+
+
+ Missing token before connector
+ Connector is inconsistent with group
+
+
+
+ from http://weblogs.asp.net/jezell/archive/2003/10/24/33376.aspx
+
+
+
+
+ The namespace URL for XHTML
+
+
+
+
+ The XHTML schema, used to validate the document
+
+
+
+
+ Initializes static members of the class.
+
+ Could not load XHTML schema from assembly
+
+
+
+ Adds a root <html> element to the given string, if it doesn't already have it
+
+ The HTML from which to create a valid document.
+ An valid instance of the given
+
+
+
+ Validates the given string, ensuring that all opened tags are closed.
+
+ The HTML to validate and close.
+ with any invalidities removed
+
+
+
+ Converts the given string into a valid XHTML document.
+
+ The HTML to convert into a navigable document.
+ The given as an XHTML document
+
+
+
+ Determines whether the given is valid for the given .
+
+ The parent element of .
+ The attribute to validate.
+
+ true if the given is valid for the given ; otherwise, false.
+
+
+
+
+ Determines whether the given element is valid for XHTML documents.
+
+ The element to validate.
+
+ true if the given element is valid for XHTML documents; otherwise, false.
+
+
+
+
+ Walks over the node and removes all invalid elements and attributes.
+
+ The node to process.
+
+
+
+ This class decodes an HTML/XML stream correctly.
+
+
+
+
+ This stack maintains a high water mark for allocated objects so the client
+ can reuse the objects in the stack to reduce memory allocations, this is
+ used to maintain current state of the parser for element stack, and attributes
+ in each element.
+
+
+
+
+ Gets or sets the item at the requested or null if is out of bounds
+
+ The item at the requested or null if is out of bounds
+
+
+
+ This class models an XML node, an array of elements in scope is maintained while parsing
+ for validation purposes, and these Node objects are reused to reduce object allocation,
+ hence the reset method.
+
+
+
+
+ Attribute objects are reused during parsing to reduce memory allocations,
+ hence the Reset method.
+
+
+
+ SgmlException.
+
+
+ SgmlException.
+
+
+ Include Section
+
+
+ External parameter entity resolution
+
+
+
+ Initializes a new instance of the class.
+
+
+
+
+ SgmlReader is an API over any SGML document (including built in
+ support for HTML).
+
+
+ An XmlReader implementation for loading SGML (including HTML) converting it
+ to well formed XML, by adding missing quotes, empty attribute values, ignoring
+ duplicate attributes, case folding on tag names, adding missing closing tags
+ based on SGML DTD information, and so on.
+
+
+
+
+ which attribute are we positioned on in the collection.
+
+
+
+
+ current node (except for attributes)
+
+
+
+
+ The base Uri is used to resolve relative Uri's like the SystemLiteral and
+ Href properties. This is a method because BaseURI is a read-only
+ property on the base XmlReader class.
+
+
+
+ i is out of range.
+
+
+ i is out of range.
+
+
+ Not on an entity reference.
+
+
+ Not on an attribute.
+
+
+ You must specify input either via Href or InputStream properties
+
+
+
+ Specify the SgmlDtd object directly. This allows you to cache the Dtd and share
+ it across multipl SgmlReaders. To load a DTD from a URL use the SystemLiteral property.
+
+
+
+
+ The name of root element specified in the DOCTYPE tag.
+
+
+
+
+ The PUBLIC identifier in the DOCTYPE tag
+
+
+
+
+ The SYSTEM literal in the DOCTYPE tag identifying the location of the DTD.
+
+
+
+
+ The DTD internal subset in the DOCTYPE tag
+
+
+
+
+ The input stream containing SGML data to parse.
+ You must specify this property or the Href property before calling Read().
+
+
+
+
+ Sometimes you need to specify a proxy server in order to load data via HTTP
+ from outside the firewall. For example: "itgproxy:80".
+
+
+
+
+ Specify the location of the input SGML document as a URL.
+
+
+
+
+ Gets or sets a value indicating whether to strip out the DOCTYPE tag from the output (default true)
+
+
+
+
+ DTD validation errors are written to this stream.
+
+
+
+
+ DTD validation errors are written to this log file.
+
+
+
+
+ This enum is used to track the current state of the
+
+
+
+ Invalid character in encoding
+
+
+ Invalid character in encoding
+
+
+
+ A 2-dimensional linear interpolator. Capture a function of 'y' over 'x'.
+ TODO generic in dimensionality
+ TODO higher degrees of interpolation and configurable extrapolation
+
+
+
+
+ Interpolate from known values.
+
+ The independent variable.
+ Interpolated value for x or exact data point if present
+ no data points are set
+
+
+
+ On assignment, add a data point.
+ On read, interpolate from data points.
+
+ The value of the independent variable.
+ An interpolated value.
+
+
+
+ Defines an implementation of which selects a key from the object based on a passed in delegate.
+ Use if implements
+
+ The type of the object being compared
+ The type of the key by which should be compared.
+ from http://stackoverflow.com/questions/98033/wrap-a-delegate-in-an-iequalitycomparer/3719802#3719802
+
+
+
+ The delegate to call on an object to get its key
+
+
+
+
+ Initializes a new instance of the class.
+
+ A function that returns the key by which the object should be compared.
+
+
+
+ Determines whether the specified objects are equal.
+
+ The first object of type to compare.
+ The second object of type to compare.
+ true if the specified objects are equal; otherwise, false.
+
+
+
+ Returns a hash code for the specified object.
+
+ The object for which a hash coade is to be returned.
+
+ A hash code for the specified object.
+
+
+
+
+ Summary description for EventNotifier.
+
+
+
+
+ Summary description for EventNotificationSectionHandler.
+
+
+
+
+ Summary description for FileNotifier.
+
+
+
+
+ Summary description for FowardOnlyEventNotifier.
+
+
+
+
+ Represents the state of the paging of a list of items
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Initializes a new instance of the class.
+
+ The current page (1-based).
+ The total number of items.
+ The number of items per page.
+ must be a non-negative number
+ must be a positive number
+
+
+
+ Creates a for the next page, otherwise this page.
+
+ A set to the next page, if there is one, otherwise this page.
+
+
+
+ Creates a for the previous page, otherwise this page.
+
+ A set to the previous page, if there is one, otherwise this page.
+
+
+
+ Creates a for the given page.
+
+ The page to be set as current for the new instance.
+ A set to the given page
+
+
+
+ Gets the current page (1-based).
+
+ The current page.
+
+
+
+ Gets the total number of items.
+
+ The total number of items.
+
+
+
+ Gets the number of items per page.
+
+ The number of items per page.
+
+
+
+ Gets the total number of pages.
+
+ The total number of pages.
+
+
+
+ A generic structure holding two related values.
+
+ The type of the first value.
+ The type of the second value.
+
+
+
+ Backing field for
+
+
+
+
+ Backing field for
+
+
+
+
+ Initializes a new instance of the struct.
+
+ The first value.
+ The second value.
+
+
+
+ Implements the operator ==.
+
+ This pair.
+ The other pair.
+ true if == , otherwise false.
+
+
+
+ Implements the operator !=.
+
+ This pair.
+ The other pair.
+ true if != , otherwise false.
+
+
+
+ Indicates whether this instance and a specified object are equal.
+
+ Another object to compare to.
+
+ true if and this instance are the same type and represent the same value; otherwise, false.
+
+
+
+
+ Returns the hash code for this instance.
+
+
+ A 32-bit signed integer that is the hash code for this instance.
+
+
+
+
+ Gets or sets the first value.
+
+ The first value.
+
+
+
+ Gets or sets the second value.
+
+ The second value.
+
+
+
+ extensions to the random number generator
+
+
+
+
+ Sample a normal distribution.
+
+ The base Random.
+ A random number from a normal distribution having mean 0 and standard deviation 1.
+
+
+
+ Generate a unique pair of numbers each from [0,max)
+
+ The base Random.
+ Generated values will be less than max.
+ First number.
+ Second number.
+
+
+
+ Generate a unique pair of numbers each from [0,max)
+
+ The base Random.
+ Generated values will be less than max.
+ Lesser number.
+ Greater number.
+
+
+
+ Generate count distinct random numbers in the range [0,max)
+
+ The base Random.
+ Generated values will be less than max.
+ quantity of random numbers to generate
+ sorted list of random numbers
+
+
+
+ Choose one item at random.
+
+ The base Random.
+ Items to choose from.
+ item type
+ one item
+
+
+
+ Choose several items at random, possibly with duplicates and omissions.
+
+ The base Random.
+ Items to choose from.
+ Number of items to choose.
+ item type
+ chosen items
+
+
+
+ Choose several distinct items at random.
+ If sample size exceeds pop size, oversample evenly.
+
+ The base Random.
+ Items to choose from.
+ Number of items to choose.
+ item type
+ chosen items
+
+
+
+ Shuffle items in place.
+
+ The base Random.
+ The items.
+ item type
+
+
+
+ Shuffle items into a new collection.
+
+ The base Random.
+ The items.
+ A list of the same items in a random permutation.
+ item type
+
+
+
+ Split items into several random sections.
+ Some sections may be empty.
+
+ The base Random.
+ The items.
+ Number of sections to split into.
+ item type
+ Disjoint sections of items in order.
+
+
+
+ Generate an endless sequence of random strings of a specified length using specified character classes.
+
+ The base instance.
+ The length of each string.
+
+ The types of character to include.
+ A lower case letter will include all lower case letters. Likewise for upper case and digits.
+ Note that representing a class multiple times in this parameter will increase occurrence of that class.
+ For example "aaaaaa0" will produce words with almost no digits.
+
+ String containing specific characters which should not be used.
+ Infinite sequence of strings.
+
+ is less than 1
+ -- OR --
+ one of the characters in is not a letter or digit
+ -- OR --
+ the excluded all characters
+
+
+
+
+ Generate an endless sequence of random strings of a specified length using specified characters.
+
+ The base instance.
+ The length of each string.
+ The character to include.
+ Infinite sequence of strings.
+
+
+
+ Summary description for RuntimeClass.
+
+
+
+
+ Summary description for ClassType.
+
+
+
+
+ Summary description for EntityType.
+
+
+
+
+ Summary description for ExportCSVCommand.
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type ID.
+ The lookup type id.
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type ID.
+ The lookup type id.
+
+
+
+
+
+
+
+
+ Represent the individual results that may return from a call to Run on a given Job.
+
+
+
+
+
+
+
+
+
+ Use this class for storing text larger than the 850 character limit on EntityAttribute
+ This data is not searchable nor versioned using the normal mechanisms
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+ Provides text sorting (case sensitive)
+
+
+
+
+ Constructor
+
+ Column to be sorted
+ true, if ascending order, false otherwise
+
+
+
+ Implementation of IComparer.Compare
+
+ First object to compare
+ Second object to compare
+ Less that zero if lhs is less than rhs. Greater than zero if lhs greater that rhs. Zero if they are equal
+
+
+
+ Overridden to do type-specific comparision.
+
+ First object to compare
+ Second object to compare
+ Less that zero if lhs is less than rhs. Greater than zero if lhs greater that rhs. Zero if they are equal
+
+
+
+ Provides text sorting (case insensitive)
+
+
+
+
+ Constructor
+
+ Column to be sorted
+ true, if ascending order, false otherwise
+
+
+
+ Case-insensitive compare
+
+
+
+
+ Provides date sorting
+
+
+
+
+ Constructor
+
+ Column to be sorted
+ true, if ascending order, false otherwise
+
+
+
+ Date compare
+
+
+
+
+ Provides integer sorting
+
+
+
+
+ Constructor
+
+ Column to be sorted
+ true, if ascending order, false otherwise
+
+
+
+ Integer compare
+
+
+
+
+ Provides floating-point sorting
+
+
+
+
+ Constructor
+
+ Column to be sorted
+ true, if ascending order, false otherwise
+
+
+
+ Floating-point compare
+
+
+
+
+ Provides sorting of ListView columns
+
+
+
+
+
+
+ ListView that this manager will provide sorting to
+ Array of Types of comparers (One for each column)
+
+
+
+ Sorts the columns
+
+ Column to be sorted
+
+
+
+ Provides currency sorting
+
+
+
+
+ Constructor
+
+ Column to be sorted
+ true, if ascending order, false otherwise
+
+
+
+ Currency compare
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+ Determines whether [is attribute value valid] [the specified s].
+
+ The s.
+
+ true if [is attribute value valid] [the specified s]; otherwise, false.
+
+
+
+
+ Returns all the valid values, plus an empty value, for
+ LookupValues for this LookupAttribute's LookupTypeID
+
+
+
+
+
+ Returns all the Lookup types
+
+
+
+
+
+ Reloads the lookups.
+
+
+
+
+ Returns all the LookupValues for the given lookupTypeId
+
+ The lookup type ID.
+
+
+
+
+ Reloads the lookup values.
+
+
+
+
+ Gets or sets the attribute value.
+
+ The attribute value.
+
+
+
+ Gets the length of the max.
+
+ The length of the max.
+
+
+
+ Gets or sets the lookup caching strategy class.
+
+ The lookup caching strategy class.
+
+
+
+
+
+
+
+
+ Summary description for ConnectionString.
+
+ user id=sa;password=secret;database=coremktg;data source=etg05;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+
+
+
+
+
+
+ Summary description for QueryStringBuilder.
+
+
+
+
+
+
+
+
+
+ Summary description for SaveMode.
+
+
+
+
+ The SortableList allows to maintain a list sorted as long as needed.
+ If no IComparer interface has been provided at construction, then the list expects the Objects to implement IComparer.
+ If the list is not sorted it behaves like an ordinary list.
+ When sorted, the list's "Add" method will put new objects at the right place.
+ As well the "Contains" and "IndexOf" methods will perform a binary search.
+
+
+
+
+ Default constructor.
+ Since no IComparer is provided here, added objects must implement the IComparer interface.
+
+
+
+
+ Constructor.
+ Since no IComparer is provided, added objects must implement the IComparer interface.
+
+ Capacity of the list (ArrayList.Capacity)
+
+
+
+ Constructor.
+
+ Will be used to compare added elements for sort and search operations.
+
+
+
+ Constructor.
+
+ Will be used to compare added elements for sort and search operations.
+ Capacity of the list (ArrayList.Capacity)
+
+
+
+ IList implementation.
+ If the KeepSorted property is set to true, the object will be added at the right place.
+ Else it will be added at the end of the list.
+
+ The object to add.
+ The index where the object has been added.
+ The SortableList is set to use object's IComparable interface, and the specifed object does not implement this interface.
+
+
+
+ IList implementation.
+ Search for a specified object in the list.
+ If the list is sorted, a BinarySearch is performed using IComparer interface.
+ Else the entity.Equals implementation is used.
+
+ The object to look for
+ true if the object is in the list, otherwise false.
+
+
+
+ IList implementation.
+ Returns the index of the specified object in the list.
+ If the list is sorted, a BinarySearch is performed using IComparer interface.
+ Else the entity.Equals implementation of objects is used.
+
+ The object to locate.
+
+ If the object has been found, a positive integer corresponding to its position.
+ If the objects has not been found, a negative integer which is the bitwise complement of the index of the next element.
+
+
+
+
+ IList implementation.
+ Idem ArrayList
+
+
+
+
+ IList implementation.
+ Inserts an objects at a specified index.
+ Cannot be used if the list has its KeepSorted property set to true.
+
+ The index before which the object must be added.
+ The object to add.
+ The SortableList is set to use object's IComparable interface, and the specifed object does not implement this interface.
+ Index is less than zero or Index is greater than Count.
+ If the object is added at the specify index, the list will not be sorted any more and the property is set to true.
+
+
+
+ IList implementation.
+ Idem ArrayList
+
+ The object whose value must be removed if found in the list.
+
+
+
+ IList implementation.
+ Idem ArrayList
+
+ Index of object to remove.
+
+
+
+ IList.ICollection implementation.
+ Idem ArrayList
+
+
+
+
+
+
+ IList.IEnumerable implementation.
+ Idem ArrayList
+
+ Enumerator on the list.
+
+
+
+ ICloneable implementation.
+ Idem ArrayList
+
+ Cloned object.
+
+
+
+ Idem IndexOf(object), but starting at a specified position in the list
+
+ The object to locate.
+ The index for start position.
+
+
+
+
+ Idem IndexOf(object), but with a specified equality function
+
+ The object to locate.
+ Equality function to use for the search.
+
+
+
+
+ Idem IndexOf(object), but with a start index and a specified equality function
+
+ The object to locate.
+ The index for start position.
+ Equality function to use for the search.
+
+
+
+
+ entity.ToString() override.
+ Build a string to represent the list.
+
+ The string refecting the list.
+
+
+
+ entity.Equals() override.
+
+ true if object is equal to this, otherwise false.
+
+
+
+ entity.GetHashCode() override.
+
+ Hash code for this.
+
+
+
+ Sorts the elements in the list using ArrayList.Sort.
+ Does nothing if the list is already sorted.
+
+
+
+
+ If the KeepSorted property is set to true, the object will be added at the right place.
+ Else it will be appended to the list.
+
+ The object to add.
+ The index where the object has been added.
+ The SortableList is set to use object's IComparable interface, and the specifed object does not implement this interface.
+
+
+
+ Inserts a collection of objects at a specified index.
+ Should not be used if the list is the KeepSorted property is set to true.
+
+ The index before which the objects must be added.
+ The object to add.
+ The SortableList is set to use objects's IComparable interface, and the specifed object does not implement this interface.
+ Index is less than zero or Index is greater than Count.
+ If the object is added at the specify index, the list will not be sorted any more and the property is set to true.
+
+
+
+ Limits the number of occurrences of a specified value.
+ Same values are equals according to the Equals() method of objects in the list.
+ The first occurrences encountered are kept.
+
+ Value whose occurrences number must be limited.
+ Number of occurrences to keep
+
+
+
+ Removes all duplicates in the list.
+ Each value encountered will have only one representant.
+
+
+
+
+ Returns the object of the list whose value is minimum
+
+ The minimum object in the list
+
+
+
+ Returns the object of the list whose value is maximum
+
+ The maximum object in the list
+
+
+
+ 'Get only' property that indicates if the list is sorted.
+
+
+
+
+ Get : Indicates if the list must be kept sorted from now on.
+ Set : Tells the list if it must stay sorted or not. Impossible to set to true if the list is not sorted.
+ KeepSorted==true implies that IsSorted==true
+
+ Cannot be set to true if the list is not sorted yet.
+
+
+
+ If set to true, it will not be possible to add an object to the list if its value is already in the list.
+
+
+
+
+ IList implementation.
+ Gets - or sets - object's value at a specified index.
+ The set operation is impossible if the KeepSorted property is set to true.
+
+ Index is less than zero or Index is greater than Count.
+ [] operator cannot be used to set a value if KeepSorted property is set to true.
+
+
+
+ IList implementation.
+ Idem ArrayList
+
+
+
+
+ IList implementation.
+ Idem ArrayList
+
+
+
+
+ IList.ICollection implementation.
+ Idem ArrayList
+
+
+
+
+ IList.ICollection implementation.
+ Idem ArrayList
+
+
+
+
+ IList.ICollection implementation.
+ Idem ArrayList
+
+
+
+
+ Idem ArrayList
+
+
+
+
+ Defines an equality for two objects
+
+
+
+
+ Defines an implementation of which selects a key from the object based on a passed in delegate.
+ Use if doesn't implement
+
+ The type of the object being compared
+ The type of the key by which should be compared.
+ from
+
+
+
+ Initializes a new instance of the class.
+
+ A function that returns the key by which the object should be compared.
+
+
+
+ Determines whether the specified objects are equal.
+
+ The first object of type to compare.
+ The second object of type to compare.
+ true if the specified objects are equal; otherwise, false.
+
+
+
+ Summary description for DebugTracer.
+
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+
+
+
+
+
+
+ An that is thread safe (uses a lock when altering the collection).
+
+ The type of keys in the dictionary.
+ The type of values in the dictionary.
+
+
+
+ The backing which implements all of the common functionality of this .
+
+
+
+
+ An to lock on when performing operations that aren't otherwise thread-safe
+
+
+
+
+ Initializes a new instance of the class that is empty, has the default initial capacity, and uses the default equality comparer for the key type.
+
+
+
+
+ Initializes a new instance of the class that is empty, has the specified initial capacity, and uses the default equality comparer for the key type.
+
+ The initial number of elements that the can contain.
+
+
+
+ Initializes a new instance of the class that is empty, has the default initial capacity, and uses the specified .
+
+ The implementation to use when comparing keys, or null to use the default for the type of the key.
+
+
+
+ Initializes a new instance of the class that is empty, has the specified initial capacity, and uses the specified .
+
+ The initial number of elements that the can contain.
+ The implementation to use when comparing keys, or null to use the default for the type of the key.
+
+
+
+ Initializes a new instance of the class that contains elements copied from the specified and uses the default equality comparer for the key type.
+
+ The whose elements are copied to the new .
+
+
+
+ Initializes a new instance of the class that contains elements copied from the specified and uses the specified .
+
+ The whose elements are copied to the new .
+ The implementation to use when comparing keys, or null to use the default for the type of the key.
+
+
+
+ Determines whether the contains an element with the specified key.
+
+ The key to locate in the .
+
+ true if the contains an element with the key; otherwise, false.
+
+
+ is null.
+
+
+
+
+ Adds an element with the provided key and value to the .
+
+ The object to use as the key of the element to add.
+ The object to use as the value of the element to add.
+
+ is null.
+
+
+ An element with the same key already exists in the .
+
+
+ The is read-only.
+
+
+
+
+ Removes the element with the specified key from the .
+
+ The key of the element to remove.
+
+ true if the element is successfully removed; otherwise, false. This method also returns false if was not found in the original .
+
+
+ is null.
+
+
+ The is read-only.
+
+
+
+
+ Gets the value associated with the specified key.
+
+ The key whose value to get.
+ When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. This parameter is passed uninitialized.
+
+ true if the object that implements contains an element with the specified key; otherwise, false.
+
+
+ is null.
+
+
+
+
+ Adds an item to the .
+
+ The object to add to the .
+
+ The is read-only.
+
+
+
+
+ Removes all items from the .
+
+
+ The is read-only.
+
+
+
+
+ Determines whether the contains a specific value.
+
+ The object to locate in the .
+
+ true if is found in the ; otherwise, false.
+
+
+
+
+ Copies the elements of the to an , starting at a particular index.
+
+ The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
+ The zero-based index in at which copying begins.
+
+ is null.
+
+
+ is less than 0.
+
+
+ is multidimensional.
+ -or-
+ is equal to or greater than the length of .
+ -or-
+ The number of elements in the source is greater than the available space from to the end of the destination .
+ -or-
+ Type cannot be cast automatically to the type of the destination .
+
+
+
+
+ Removes the first occurrence of a specific object from the .
+
+ The object to remove from the .
+
+ true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original .
+
+
+ The is read-only.
+
+
+
+
+ Returns an enumerator that iterates through a collection.
+
+
+ An object that can be used to iterate through the collection.
+
+ NotImplementedException.
+
+
+
+ Returns an enumerator that iterates through the collection.
+
+
+ A that can be used to iterate through the collection.
+
+ NotImplementedException.
+
+
+
+ Gets an containing the keys of the .
+
+
+
+ An containing the keys of the object that implements .
+
+
+
+
+ Gets an containing the values in the .
+
+
+
+ An containing the values in the object that implements .
+
+
+
+
+ Gets the number of elements contained in the .
+
+
+
+ The number of elements contained in the .
+
+
+
+
+ Gets a value indicating whether the is read-only.
+
+
+ true if the is read-only; otherwise, false.
+
+
+
+
+ Gets or sets the element with the specified key.
+
+
+ The element with the specified key.
+
+ The key of the element to get or set.
+ The property is set and the is read-only.
+ key is null.
+ The property is retrieved and key is not found.
+
+
+
+ This class represents a time period
+
+
+
+
+ Creates a TimeCycle that is always active
+
+
+
+
+ Creates a TimeCycle that is active between the startHour and stopHour
+
+ Hour that this TimeCycle becomes active (24 hour time)
+ Hour that this TimeCycle becomes inactive (24 hour time)
+
+
+
+ Creates a TimeCycle that is active between the startHour/startMinute and stopHour/stopMinute
+
+ Hour that this TimeCycle becomes active (24 hour time)
+ Minute that this TimeCycle becomes active for the startHour
+ Hour that this TimeCycle becomes inactive (24 hour time)
+ Minute that this TimeCycle becomes inactive for the stopHour
+
+
+
+ This method calculates the number of milliseconds to sleep if during an inactive
+ period. If during an active period, 0 is returned.
+
+ The number of milliseconds to sleep
+
+
+
+ Returns a string representing the startTime of this TimeCycle
+
+
+
+
+
+ Returns a string representing the stopTime of this TimeCycle
+
+
+
+
+
+ Private method that gets the current time and based on the start and stop times adjusts
+ the times to test if this TimeCycle is active.
+
+
+
+
+ Returns a string representation of the TimeCycle object
+
+
+
+
+
+ This method returns a bool to indicate if this TimeCycle
+ is currently active.
+
+
+
+
+ Returns a bool indicating the the SleepDay function is enabled
+
+
+
+
+ Returns the DayOfWeek Enum that this TimeCycle sleeps, if enabled
+
+
+
+
+ Represents a time zone and provides access to all system time zones.
+
+
+ Author: Arman Ghazanchyan
+ Created date: 09/04/2007
+ Last updated: 09/17/2007
+ From: http://www.codeproject.com/KB/vb/TimeZoneInfo.aspx
+
+ for the ability to read the specified registry key. Associated enumeration:
+
+
+
+ Backing field for .
+
+
+
+
+ Backing field for .
+
+
+
+
+ Backing for this instance.
+
+
+
+
+ Initializes a new instance of the class.
+
+ A time zone standard name.
+
+
+
+ Prevents a default instance of the TimeZoneInfo class from being created.
+
+
+
+
+ Gets an array of all time zones on the system.
+
+ An array of all time zones on the system.
+ Cannot find the windows registry key (Time Zone).
+ The user does not have permissions required to access the Time Zones registry key.
+ for the ability to read the specified registry key. Associated enumeration:
+
+
+
+ Sorts the elements in a list(Of TimeZoneInfo)
+ object based on standard UTC offset or display name.
+
+ A time zone list to sort.
+
+
+
+ Sorts the elements in an entire one-dimensional TimeZoneInfo
+ array based on standard UTC offset or display name.
+
+ A time zone array to sort.
+
+
+
+ Gets a TimeZoneInfo.Object from standard name.
+
+ A time zone standard name.
+ A TimeZoneInfo instance filled with the information about the time zone with the given name
+
+
+
+ Gets a TimeZoneInfo.Object from Id.
+
+ A time zone id that corresponds
+ to the windows registry time zone key.
+ A TimeZoneInfo instance filled with the information about the time zone with the Id
+ Cannot find the windows registry key (Time Zone).
+ Unknown time zone.
+ id is null.
+ The user does not have permissions required to access the Time Zones registry key.
+ for the ability to read the specified registry key. Associated enumeration:
+
+
+
+ Gets the daylight saving time for a particular year.
+
+ The year to which the daylight
+ saving time period applies.
+ The daylight saving time for a particular year
+ Cannot find the windows registry key (Time Zone).
+ Unknown time zone.
+ The user does not have permissions required to access the Time Zones registry key.
+ for the ability to read the specified registry key. Associated enumeration:
+
+
+
+ Returns a value indicating whether this time
+ zone is within a daylight saving time period.
+
+
+ true if this time zone is within a daylight saving time period; otherwise, false.
+
+
+
+
+ Refreshes the information of the time zone object.
+
+
+
+
+ Returns a System.String that represents the current TimeZoneInfo object.
+
+
+ A that represents the current .
+
+
+
+
+ Determines whether the specified System.Object
+ is equal to the current System.Object.
+
+ The System.Object to compare
+ with the current System.Object.
+
+ true if the specified is equal to the current ; otherwise, false.
+
+
+ The parameter is null.
+
+
+
+
+ Indicates whether the current object is equal to another object of the same type.
+
+
+ true if the current object is equal to the parameter; otherwise, false.
+
+
+ An object to compare with this object.
+
+
+
+
+ Serves as a hash function for a particular type.
+
+
+ A hash code for the current .
+
+
+
+
+ Compares two specified TimeZoneInfo.Objects
+ based on standard UTC offset or display name.
+
+ The first TimeZoneInfo.Object.
+ The second TimeZoneInfo.Object.
+
+ Value
+ Condition
+ Less than zero
+ is less than .
+ Zero
+ equals .
+ Greater than zero
+ is greater than .
+
+
+
+
+ Creates and returns a date and time object.
+
+ The year of the date.
+ The month of the date.
+ The week day in the month.
+ The day of the week.
+ The hour of the date.
+ The minute of the date.
+ The seconds of the date.
+ The milliseconds of the date.
+ A date and time object
+ Day is out of range.
+ DayOfWeek is out of range.
+
+
+
+ Gets the starting daylight saving date and time for specified time zone.
+
+ The time fone info.
+ The year whose daylight saving time information is to be retrieved.
+ The starting daylight saving date and time for specified time zone
+ timeZoneInfo.DaylightDate.Month must not be 0
+
+
+
+ Gets the end date of the daylight saving time for specified time zone.
+
+ The time zone info.
+ The year whose daylight saving time information is to be retrieved.
+ The end date of the daylight saving time for specified time zone
+ timeZoneInfo.StandardDate.Month must not be 0
+
+
+
+ Sets the time zone object's information.
+
+ Cannot find the windows registry key (Time Zone).
+ Unknown time zone.
+ The user does not have permissions required to access the Time Zones registry key.
+ for the ability to read the specified registry key. Associated enumeration:
+
+
+
+ Sets the time zone object's information.
+
+ A time zone standard name.
+ Cannot find the windows registry key (Time Zone).
+ Unknown time zone.
+ StandardName is null.
+ The user does not have permissions required to access the Time Zones registry key.
+ for the ability to read the specified registry key. Associated enumeration:
+
+
+
+ Gets the current time zone for this computer system.
+
+
+
+
+ Gets the display name of the time zone.
+
+
+
+
+ Gets the daylight saving name of the time zone.
+
+
+
+
+ Gets the standard name of the time zone.
+
+
+
+
+ Gets the current date and time of the time zone.
+
+
+
+
+ Gets the current UTC (Coordinated Universal Time) offset of the time zone.
+
+
+
+
+ Gets the standard UTC (Coordinated Universal Time) offset of the time zone.
+
+
+
+
+ Gets the id of the time zone.
+
+
+
+
+ A time structure
+
+
+
+
+ The year of this instance
+
+
+
+
+ The month of this instance
+
+
+
+
+ The day of the week of this instance
+
+
+
+
+ The day of the month of this instance
+
+
+
+
+ The hour of this instance
+
+
+
+
+ The minute of this instance
+
+
+
+
+ The second of this instance
+
+
+
+
+ The millisecond of this instance
+
+
+
+
+ Sets the member values of the time structure.
+
+ A byte array that contains the information of a time.
+ Information size is incorrect
+
+
+
+ Determines whether the specified System.Object
+ is equal to the current System.Object.
+
+ The System.Object to compare
+ with the current System.Object.
+
+ true if and this instance are the same type and represent the same value; otherwise, false.
+
+
+
+
+ A structure representing time zone information
+
+
+
+
+ The difference from UTC for this time zone
+
+
+
+
+ The name of this time zone
+
+
+
+
+ The standard date for this time zone
+
+
+
+
+ The difference from UTC of
+
+
+
+
+ The name of the time zone in Daylight Saving Time
+
+
+
+
+ The daylight saving date for this time zone
+
+
+
+
+ The difference from UTC of
+
+
+
+
+ Sets the member values of bias, StandardBias,
+ DaylightBias, StandardDate, DaylightDate of the structure.
+
+ A byte array that contains the
+ information of the Tzi windows registry key.
+ Information size is incorrect
+
+
+
+ Determines whether the specified System.Object
+ is equal to the current System.Object.
+
+ The System.Object to compare
+ with the current System.Object.
+
+ true if and this instance are the same type and represent the same value; otherwise, false.
+
+
+
+ An immutable pair of integers with no preserved ordering.
+
+
+ Initializes a new instance of the class.
+ A value.
+ Another value.
+
+
+ Prevents a default instance of the class from being created.
+
+
+ Get the "other" value from this pair.
+ The value _not_ to get.
+ The value paired with the given value.
+
+
+ Test whether a value belongs to this pair.
+ The value.
+ true if the given value is in this pair.
+
+
+ Determine whether this and another pair share one or both values.
+ The other pair.
+ true if the two pairs share at least one value.
+
+
+ Determine whether this and a set share any values.
+ The set of values to check against.
+ true if either of this pair's values are in the set.
+
+
+ Determine whether this and another pair are equal.
+ The other pair.
+ true if this is identical to other.
+
+
+ Generate a hash code.
+ A value likely to be unique to this pair of integers.
+
+
+ Gets the lesser of the two values.
+
+
+ Gets the greater of the two values.
+
+
+ Gets the positive difference between the two values.
+
+
+ Gets the two values as an enumerable sequence.
+
+
+ Keep track of the number of pairings of numbers.
+
+
+
+ The pairing tallies, keyed by lesser value of pair:
+ tallies[lesser][greater] = number of such pairings in the set
+
+
+ This structure will be pruned as needed.
+ There should never be any empty child dictionaries.
+
+
+
+
+ The tallies, keyed by all distinct pair members.
+ flatTallies[x] = number of pairs in the set which include x
+
+
+ This structure will be pruned as needed.
+ Its key collection may be taken as the union of all pairs in the set.
+
+
+
+ Initializes a new instance of the class.
+
+
+ Initializes a new instance of the class.
+ A single pair to populate the set with.
+
+
+ Initializes a new instance of the class.
+ The set to copy.
+
+
+ Initializes a new instance of the class.
+ The pairs to load initially.
+
+
+ Add a pairing to the set.
+ The pair to add.
+
+
+ Create a new pair set which duplicates this one except for certain values.
+ The values to forbid appearing in the copy.
+ A new, possibly smaller .
+
+
+ Remove a pair from the set.
+ The pair to remove.
+
+
+ Remove any and all pairings including a certain value.
+ The value to find in pairings.
+
+
+ Remove all pairs from the set which have both values in a given set of values.
+ The values to test pairs against.
+
+
+ Transform this set forward through a one-to-one mapping of values.
+ The value translation map.
+ A copy of this set with all pair members translated.
+
+
+ Determine whether any pairs are in the set.
+ true if there is at least one pair.
+
+
+ Get the total number of pairings in the set.
+ The number of pairings.
+
+
+ Get the quantity of a pair in the set.
+ The pair.
+ The number of such pairs in the set.
+
+
+ Get the count of all pairs which include a certain value.
+ The value to have appeared in each pair.
+ The number of all pairs where x is included.
+
+
+ Get any and all single values which occur a given number of times.
+ The count to match.
+ A sequence of values.
+
+
+ Get the counts of certain pairs in this set which also appear in another set.
+ Only provide counts for pairs also appearing in this set.
+ A sequence of tallies of certain pairs in this set.
+
+
+ Determine whether this and a pair share any values.
+ The pair to check against.
+ true if either of the pair's values are in this set.
+
+
+ Determine whether a certain value is in any pair in the set.
+ The value to search for.
+ true if at least one pair includes the value.
+
+
+ Get all values which have at least one pairing with a certain value.
+ The value to get partners for.
+ A sequence of all values paired with x.
+
+
+ Get a list of all values paired with each value.
+ A mapping of each value to a list of its paired values.
+
+
+
+ For a given "lesser" value, get the existing set of its partners;
+ create one if necessary.
+
+ The value.
+ The mappings of the value's pairings to tallies.
+
+
+ Gets all the distinct values among all pairs.
+
+
+ Gets all the pairs including duplicates.
+
+
+ Gets the maximum difference in values among all pairs in the set.
+
+
+ Gets the number of occurrences of the rarest single value(s).
+
+
+ Gets the number of occurrences of the most numerous single value(s).
+
+
+
+ This validates the domain portion of a URL to exists. i.e. www.google.com.
+
+
+
+ Do not include http:// as part of domain name. This will return false.
+
+
+
+ Encrypts the passed string
+
+ The string you want encrypted
+ An Encrypted String
+
+
+
+ Decrypts the passed string
+
+ The string you want decrypted
+ A decrypted String
+
+
+
+ This method will return the HTML from a URL to a web page. This works
+ for html pages, .aspx pages, and asp pages, (and probaby any other server side page that renders html content..)
+
+
+ string - the html
+
+
+
+ This method is used to change the role type for "Role" objects. It uses the AssignRequiredAffiliations
+ method to get a list of parents in the tree to remove and reassign using the new object typeid.
+
+
+
+
+
+
+
+ ChangeRole(72, account, physician, 123, sessionBase)
+
+
+
+
+
+ An ArrayList of IDictionary objects
+ An IDictionary object containing the results of logically AND'ing the keys
+
+
+
+
+
+ An ArrayList of IDictionary objects
+ An IDictionary object containing the results of logically OR'ing the keys
+
+
+
+ Removes entites and tags from
+
+
+
+
+
+
+
+ Removes any HTML entities ( < etc)
+
+ string from which to remove HTML entities
+ leave spaces as spaces or remove
+ string with any HTML entities removed
+
+
+
+ Removes Html Tags ("<....>")
+
+ String to remove HTML entities
+ leave spaces as spaces or remove
+ string with any Html tags removed
+
+
+
+
+
+
+
+
+ Initializes a new instance of the class.
+
+ if set to true [required].
+ The object type id.
+ The lookup type id.
+
+
+
+
+
+
+
+
+ A collection of static utility methods and fields that are generally useful.
+
+
+ A regular expression which will match an email address
+
+ Because this needs to work in JavaScript and .NET, we can't just set , we have to manually include both cases for each letter
+ Basic Explanation: Any valid characters, @ symbol, any valid characters, . (period), then either two letters or one of the other 25 top-level-domains
+
+ Beginning of line or string
+ Any character in this class: [a-zA-Z0-9._%\-+'], one or more repetitions
+ @
+ Match expression but don't capture it. [[a-zA-Z0-9\-]+\.], one or more repetitions
+ [a-zA-Z0-9\-]+\.
+ Any character in this class: [a-zA-Z0-9\-], one or more repetitions
+ Literal .
+ Match expression but don't capture it. [[a-zA-Z]{2}|[Aa][Ee][Rr][Oo]|[Aa][Rr][Pp][Aa]|[Aa][Ss][Ii][Aa]|[Bb][Ii][Zz]|[Cc][Aa][Tt]|[Cc][Oo][Mm]|[Cc][Oo][Oo][Pp]|[Ee][dD][Uu]|[Gg][Oo][Vv]|[Ii][Nn][Ff][Oo]|[Ii][Nn][Tt]|[Jj][Oo][Bb][Ss]|[Mm][Ii][Ll]|[Mm][Oo][Bb][Ii]|[Mm][Uu][Ss][Ee][Uu][Mm]|[Nn][Aa][Mm][Ee]|[Nn][Ee][Tt]|[Oo][Rr][Gg]|[Pp][Rr][Oo]|[Rr][Oo][Oo][Tt]|[Tt][Ee][Ll]|[Tt][Rr][Aa][Vv][Ee][Ll]|[Cc][Yy][Mm]|[Gg][Ee][Oo]|[Pp][Oo][Ss][Tt]]
+ Select from 26 alternatives
+ Any character in this class: [a-zA-Z], exactly 2 repetitions
+ [Aa][Ee][Rr][Oo]
+ Any character in this class: [Aa]
+ Any character in this class: [Ee]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ [Aa][Rr][Pp][Aa]
+ Any character in this class: [Aa]
+ Any character in this class: [Rr]
+ Any character in this class: [Pp]
+ Any character in this class: [Aa]
+ [Aa][Ss][Ii][Aa]
+ Any character in this class: [Aa]
+ Any character in this class: [Ss]
+ Any character in this class: [Ii]
+ Any character in this class: [Aa]
+ [Bb][Ii][Zz]
+ Any character in this class: [Bb]
+ Any character in this class: [Ii]
+ Any character in this class: [Zz]
+ [Cc][Aa][Tt]
+ Any character in this class: [Cc]
+ Any character in this class: [Aa]
+ Any character in this class: [Tt]
+ [Cc][Oo][Mm]
+ Any character in this class: [Cc]
+ Any character in this class: [Oo]
+ Any character in this class: [Mm]
+ [Cc][Oo][Oo][Pp]
+ Any character in this class: [Cc]
+ Any character in this class: [Oo]
+ Any character in this class: [Oo]
+ Any character in this class: [Pp]
+ [Ee][dD][Uu]
+ Any character in this class: [Ee]
+ Any character in this class: [dD]
+ Any character in this class: [Uu]
+ [Gg][Oo][Vv]
+ Any character in this class: [Gg]
+ Any character in this class: [Oo]
+ Any character in this class: [Vv]
+ [Ii][Nn][Ff][Oo]
+ Any character in this class: [Ii]
+ Any character in this class: [Nn]
+ Any character in this class: [Ff]
+ Any character in this class: [Oo]
+ [Ii][Nn][Tt]
+ Any character in this class: [Ii]
+ Any character in this class: [Nn]
+ Any character in this class: [Tt]
+ [Jj][Oo][Bb][Ss]
+ Any character in this class: [Jj]
+ Any character in this class: [Oo]
+ Any character in this class: [Bb]
+ Any character in this class: [Ss]
+ [Mm][Ii][Ll]
+ Any character in this class: [Mm]
+ Any character in this class: [Ii]
+ Any character in this class: [Ll]
+ [Mm][Oo][Bb][Ii]
+ Any character in this class: [Mm]
+ Any character in this class: [Oo]
+ Any character in this class: [Bb]
+ Any character in this class: [Ii]
+ [Mm][Uu][Ss][Ee][Uu][Mm]
+ Any character in this class: [Mm]
+ Any character in this class: [Uu]
+ Any character in this class: [Ss]
+ Any character in this class: [Ee]
+ Any character in this class: [Uu]
+ Any character in this class: [Mm]
+ [Nn][Aa][Mm][Ee]
+ Any character in this class: [Nn]
+ Any character in this class: [Aa]
+ Any character in this class: [Mm]
+ Any character in this class: [Ee]
+ [Nn][Ee][Tt]
+ Any character in this class: [Nn]
+ Any character in this class: [Ee]
+ Any character in this class: [Tt]
+ [Oo][Rr][Gg]
+ Any character in this class: [Oo]
+ Any character in this class: [Rr]
+ Any character in this class: [Gg]
+ [Pp][Rr][Oo]
+ Any character in this class: [Pp]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ [Rr][Oo][Oo][Tt]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ Any character in this class: [Oo]
+ Any character in this class: [Tt]
+ [Tt][Ee][Ll]
+ Any character in this class: [Tt]
+ Any character in this class: [Ee]
+ Any character in this class: [Ll]
+ [Tt][Rr][Aa][Vv][Ee][Ll]
+ Any character in this class: [Tt]
+ Any character in this class: [Rr]
+ Any character in this class: [Aa]
+ Any character in this class: [Vv]
+ Any character in this class: [Ee]
+ Any character in this class: [Ll]
+ [Cc][Yy][Mm]
+ Any character in this class: [Cc]
+ Any character in this class: [Yy]
+ Any character in this class: [Mm]
+ [Gg][Ee][Oo]
+ Any character in this class: [Gg]
+ Any character in this class: [Ee]
+ Any character in this class: [Oo]
+ [Pp][Oo][Ss][Tt]
+ Any character in this class: [Pp]
+ Any character in this class: [Oo]
+ Any character in this class: [Ss]
+ Any character in this class: [Tt]
+ End of line or string
+
+
+
+ A regular expression which will match a comma-delimited list of email addresses
+
+ Because this needs to work in JavaScript and .NET, we can't just set , we have to manually include both cases for each letter
+
+ Basic Explanation: Any valid characters, @ symbol, any valid characters, . (period), then either two letters or one of the other 25 top-level-domains.
+ Then, any number of times, an optional additional comma, whitespace, and the same pattern as above (that is, another email address)
+
+
+ Beginning of line or string
+ Any character in this class: [a-zA-Z0-9._%\-+'], one or more repetitions
+ @
+ Match expression but don't capture it. [[a-zA-Z0-9\-]+\.], one or more repetitions
+ [a-zA-Z0-9\-]+\.
+ Any character in this class: [a-zA-Z0-9\-], one or more repetitions
+ Literal .
+ Match expression but don't capture it. [[a-zA-Z]{2}|[Aa][Ee][Rr][Oo]|[Aa][Rr][Pp][Aa]|[Aa][Ss][Ii][Aa]|[Bb][Ii][Zz]|[Cc][Aa][Tt]|[Cc][Oo][Mm]|[Cc][Oo][Oo][Pp]|[Ee][dD][Uu]|[Gg][Oo][Vv]|[Ii][Nn][Ff][Oo]|[Ii][Nn][Tt]|[Jj][Oo][Bb][Ss]|[Mm][Ii][Ll]|[Mm][Oo][Bb][Ii]|[Mm][Uu][Ss][Ee][Uu][Mm]|[Nn][Aa][Mm][Ee]|[Nn][Ee][Tt]|[Oo][Rr][Gg]|[Pp][Rr][Oo]|[Rr][Oo][Oo][Tt]|[Tt][Ee][Ll]|[Tt][Rr][Aa][Vv][Ee][Ll]|[Cc][Yy][Mm]|[Gg][Ee][Oo]|[Pp][Oo][Ss][Tt]]
+ Select from 26 alternatives
+ Any character in this class: [a-zA-Z], exactly 2 repetitions
+ [Aa][Ee][Rr][Oo]
+ Any character in this class: [Aa]
+ Any character in this class: [Ee]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ [Aa][Rr][Pp][Aa]
+ Any character in this class: [Aa]
+ Any character in this class: [Rr]
+ Any character in this class: [Pp]
+ Any character in this class: [Aa]
+ [Aa][Ss][Ii][Aa]
+ Any character in this class: [Aa]
+ Any character in this class: [Ss]
+ Any character in this class: [Ii]
+ Any character in this class: [Aa]
+ [Bb][Ii][Zz]
+ Any character in this class: [Bb]
+ Any character in this class: [Ii]
+ Any character in this class: [Zz]
+ [Cc][Aa][Tt]
+ Any character in this class: [Cc]
+ Any character in this class: [Aa]
+ Any character in this class: [Tt]
+ [Cc][Oo][Mm]
+ Any character in this class: [Cc]
+ Any character in this class: [Oo]
+ Any character in this class: [Mm]
+ [Cc][Oo][Oo][Pp]
+ Any character in this class: [Cc]
+ Any character in this class: [Oo]
+ Any character in this class: [Oo]
+ Any character in this class: [Pp]
+ [Ee][dD][Uu]
+ Any character in this class: [Ee]
+ Any character in this class: [dD]
+ Any character in this class: [Uu]
+ [Gg][Oo][Vv]
+ Any character in this class: [Gg]
+ Any character in this class: [Oo]
+ Any character in this class: [Vv]
+ [Ii][Nn][Ff][Oo]
+ Any character in this class: [Ii]
+ Any character in this class: [Nn]
+ Any character in this class: [Ff]
+ Any character in this class: [Oo]
+ [Ii][Nn][Tt]
+ Any character in this class: [Ii]
+ Any character in this class: [Nn]
+ Any character in this class: [Tt]
+ [Jj][Oo][Bb][Ss]
+ Any character in this class: [Jj]
+ Any character in this class: [Oo]
+ Any character in this class: [Bb]
+ Any character in this class: [Ss]
+ [Mm][Ii][Ll]
+ Any character in this class: [Mm]
+ Any character in this class: [Ii]
+ Any character in this class: [Ll]
+ [Mm][Oo][Bb][Ii]
+ Any character in this class: [Mm]
+ Any character in this class: [Oo]
+ Any character in this class: [Bb]
+ Any character in this class: [Ii]
+ [Mm][Uu][Ss][Ee][Uu][Mm]
+ Any character in this class: [Mm]
+ Any character in this class: [Uu]
+ Any character in this class: [Ss]
+ Any character in this class: [Ee]
+ Any character in this class: [Uu]
+ Any character in this class: [Mm]
+ [Nn][Aa][Mm][Ee]
+ Any character in this class: [Nn]
+ Any character in this class: [Aa]
+ Any character in this class: [Mm]
+ Any character in this class: [Ee]
+ [Nn][Ee][Tt]
+ Any character in this class: [Nn]
+ Any character in this class: [Ee]
+ Any character in this class: [Tt]
+ [Oo][Rr][Gg]
+ Any character in this class: [Oo]
+ Any character in this class: [Rr]
+ Any character in this class: [Gg]
+ [Pp][Rr][Oo]
+ Any character in this class: [Pp]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ [Rr][Oo][Oo][Tt]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ Any character in this class: [Oo]
+ Any character in this class: [Tt]
+ [Tt][Ee][Ll]
+ Any character in this class: [Tt]
+ Any character in this class: [Ee]
+ Any character in this class: [Ll]
+ [Tt][Rr][Aa][Vv][Ee][Ll]
+ Any character in this class: [Tt]
+ Any character in this class: [Rr]
+ Any character in this class: [Aa]
+ Any character in this class: [Vv]
+ Any character in this class: [Ee]
+ Any character in this class: [Ll]
+ [Cc][Yy][Mm]
+ Any character in this class: [Cc]
+ Any character in this class: [Yy]
+ Any character in this class: [Mm]
+ [Gg][Ee][Oo]
+ Any character in this class: [Gg]
+ Any character in this class: [Ee]
+ Any character in this class: [Oo]
+ [Pp][Oo][Ss][Tt]
+ Any character in this class: [Pp]
+ Any character in this class: [Oo]
+ Any character in this class: [Ss]
+ Any character in this class: [Tt]
+ Match expression but don't capture it. [,\s?[a-zA-Z0-9._%\-+']+@(?:[a-zA-Z0-9\-]+\.)+(?:[a-zA-Z]{2}|[Aa][Ee][Rr][Oo]|[Aa][Rr][Pp][Aa]|[Aa][Ss][Ii][Aa]|[Bb][Ii][Zz]|[Cc][Aa][Tt]|[Cc][Oo][Mm]|[Cc][Oo][Oo][Pp]|[Ee][dD][Uu]|[Gg][Oo][Vv]|[Ii][Nn][Ff][Oo]|[Ii][Nn][Tt]|[Jj][Oo][Bb][Ss]|[Mm][Ii][Ll]|[Mm][Oo][Bb][Ii]|[Mm][Uu][Ss][Ee][Uu][Mm]|[Nn][Aa][Mm][Ee]|[Nn][Ee][Tt]|[Oo][Rr][Gg]|[Pp][Rr][Oo]|[Rr][Oo][Oo][Tt]|[Tt][Ee][Ll]|[Tt][Rr][Aa][Vv][Ee][Ll]|[Cc][Yy][Mm]|[Gg][Ee][Oo]|[Pp][Oo][Ss][Tt])], any number of repetitions
+ ,\s?[a-zA-Z0-9._%\-+']+@(?:[a-zA-Z0-9\-]+\.)+(?:[a-zA-Z]{2}|[Aa][Ee][Rr][Oo]|[Aa][Rr][Pp][Aa]|[Aa][Ss][Ii][Aa]|[Bb][Ii][Zz]|[Cc][Aa][Tt]|[Cc][Oo][Mm]|[Cc][Oo][Oo][Pp]|[Ee][dD][Uu]|[Gg][Oo][Vv]|[Ii][Nn][Ff][Oo]|[Ii][Nn][Tt]|[Jj][Oo][Bb][Ss]|[Mm][Ii][Ll]|[Mm][Oo][Bb][Ii]|[Mm][Uu][Ss][Ee][Uu][Mm]|[Nn][Aa][Mm][Ee]|[Nn][Ee][Tt]|[Oo][Rr][Gg]|[Pp][Rr][Oo]|[Rr][Oo][Oo][Tt]|[Tt][Ee][Ll]|[Tt][Rr][Aa][Vv][Ee][Ll]|[Cc][Yy][Mm]|[Gg][Ee][Oo]|[Pp][Oo][Ss][Tt])
+ ,
+ Whitespace, zero or one repetitions
+ Any character in this class: [a-zA-Z0-9._%\-+'], one or more repetitions
+ @
+ Match expression but don't capture it. [[a-zA-Z0-9\-]+\.], one or more repetitions
+ [a-zA-Z0-9\-]+\.
+ Any character in this class: [a-zA-Z0-9\-], one or more repetitions
+ Literal .
+ Match expression but don't capture it. [[a-zA-Z]{2}|[Aa][Ee][Rr][Oo]|[Aa][Rr][Pp][Aa]|[Aa][Ss][Ii][Aa]|[Bb][Ii][Zz]|[Cc][Aa][Tt]|[Cc][Oo][Mm]|[Cc][Oo][Oo][Pp]|[Ee][dD][Uu]|[Gg][Oo][Vv]|[Ii][Nn][Ff][Oo]|[Ii][Nn][Tt]|[Jj][Oo][Bb][Ss]|[Mm][Ii][Ll]|[Mm][Oo][Bb][Ii]|[Mm][Uu][Ss][Ee][Uu][Mm]|[Nn][Aa][Mm][Ee]|[Nn][Ee][Tt]|[Oo][Rr][Gg]|[Pp][Rr][Oo]|[Rr][Oo][Oo][Tt]|[Tt][Ee][Ll]|[Tt][Rr][Aa][Vv][Ee][Ll]|[Cc][Yy][Mm]|[Gg][Ee][Oo]|[Pp][Oo][Ss][Tt]]
+ Select from 26 alternatives
+ Any character in this class: [a-zA-Z], exactly 2 repetitions
+ [Aa][Ee][Rr][Oo]
+ Any character in this class: [Aa]
+ Any character in this class: [Ee]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ [Aa][Rr][Pp][Aa]
+ Any character in this class: [Aa]
+ Any character in this class: [Rr]
+ Any character in this class: [Pp]
+ Any character in this class: [Aa]
+ [Aa][Ss][Ii][Aa]
+ Any character in this class: [Aa]
+ Any character in this class: [Ss]
+ Any character in this class: [Ii]
+ Any character in this class: [Aa]
+ [Bb][Ii][Zz]
+ Any character in this class: [Bb]
+ Any character in this class: [Ii]
+ Any character in this class: [Zz]
+ [Cc][Aa][Tt]
+ Any character in this class: [Cc]
+ Any character in this class: [Aa]
+ Any character in this class: [Tt]
+ [Cc][Oo][Mm]
+ Any character in this class: [Cc]
+ Any character in this class: [Oo]
+ Any character in this class: [Mm]
+ [Cc][Oo][Oo][Pp]
+ Any character in this class: [Cc]
+ Any character in this class: [Oo]
+ Any character in this class: [Oo]
+ Any character in this class: [Pp]
+ [Ee][dD][Uu]
+ Any character in this class: [Ee]
+ Any character in this class: [dD]
+ Any character in this class: [Uu]
+ [Gg][Oo][Vv]
+ Any character in this class: [Gg]
+ Any character in this class: [Oo]
+ Any character in this class: [Vv]
+ [Ii][Nn][Ff][Oo]
+ Any character in this class: [Ii]
+ Any character in this class: [Nn]
+ Any character in this class: [Ff]
+ Any character in this class: [Oo]
+ [Ii][Nn][Tt]
+ Any character in this class: [Ii]
+ Any character in this class: [Nn]
+ Any character in this class: [Tt]
+ [Jj][Oo][Bb][Ss]
+ Any character in this class: [Jj]
+ Any character in this class: [Oo]
+ Any character in this class: [Bb]
+ Any character in this class: [Ss]
+ [Mm][Ii][Ll]
+ Any character in this class: [Mm]
+ Any character in this class: [Ii]
+ Any character in this class: [Ll]
+ [Mm][Oo][Bb][Ii]
+ Any character in this class: [Mm]
+ Any character in this class: [Oo]
+ Any character in this class: [Bb]
+ Any character in this class: [Ii]
+ [Mm][Uu][Ss][Ee][Uu][Mm]
+ Any character in this class: [Mm]
+ Any character in this class: [Uu]
+ Any character in this class: [Ss]
+ Any character in this class: [Ee]
+ Any character in this class: [Uu]
+ Any character in this class: [Mm]
+ [Nn][Aa][Mm][Ee]
+ Any character in this class: [Nn]
+ Any character in this class: [Aa]
+ Any character in this class: [Mm]
+ Any character in this class: [Ee]
+ [Nn][Ee][Tt]
+ Any character in this class: [Nn]
+ Any character in this class: [Ee]
+ Any character in this class: [Tt]
+ [Oo][Rr][Gg]
+ Any character in this class: [Oo]
+ Any character in this class: [Rr]
+ Any character in this class: [Gg]
+ [Pp][Rr][Oo]
+ Any character in this class: [Pp]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ [Rr][Oo][Oo][Tt]
+ Any character in this class: [Rr]
+ Any character in this class: [Oo]
+ Any character in this class: [Oo]
+ Any character in this class: [Tt]
+ [Tt][Ee][Ll]
+ Any character in this class: [Tt]
+ Any character in this class: [Ee]
+ Any character in this class: [Ll]
+ [Tt][Rr][Aa][Vv][Ee][Ll]
+ Any character in this class: [Tt]
+ Any character in this class: [Rr]
+ Any character in this class: [Aa]
+ Any character in this class: [Vv]
+ Any character in this class: [Ee]
+ Any character in this class: [Ll]
+ [Cc][Yy][Mm]
+ Any character in this class: [Cc]
+ Any character in this class: [Yy]
+ Any character in this class: [Mm]
+ [Gg][Ee][Oo]
+ Any character in this class: [Gg]
+ Any character in this class: [Ee]
+ Any character in this class: [Oo]
+ [Pp][Oo][Ss][Tt]
+ Any character in this class: [Pp]
+ Any character in this class: [Oo]
+ Any character in this class: [Ss]
+ Any character in this class: [Tt]
+ End of line or string
+
+
+
+ A regular expression which will match a US phone number with (required) area code
+
+
+ Basic explanation: Optional whitespace, open parenthesis, whitespace, then three numbers,
+ then optional whitespace, closed parenthesis, whitespace, any of the following - \ / . *, and whitespace, then three numbers,
+ then optional whitespace, any of the following - \ / . * and whitespace, then four numbers,
+ then optional whitespace
+
+ ^\s*\(?\s*
+ Beginning of line or string
+ Whitespace, any number of repetitions
+ Literal (, zero or one repetitions
+ Whitespace, any number of repetitions
+ [AreaCode]: A named capture group. [\d{3}]
+ Any digit, exactly 3 repetitions
+ \s*\)?\s*-?\\?/?\.?\*?\s*
+ Whitespace, any number of repetitions
+ Literal ), zero or one repetitions
+ Whitespace, any number of repetitions
+ -, zero or one repetitions
+ Literal \, zero or one repetitions
+ /, zero or one repetitions
+ Literal ., zero or one repetitions
+ Literal *, zero or one repetitions
+ Whitespace, any number of repetitions
+ [FirstThree]: A named capture group. [\d{3}]
+ Any digit, exactly 3 repetitions
+ \s*-?\\?/?\.?\*?\s*
+ Whitespace, any number of repetitions
+ -, zero or one repetitions
+ Literal \, zero or one repetitions
+ /, zero or one repetitions
+ Literal ., zero or one repetitions
+ Literal *, zero or one repetitions
+ Whitespace, any number of repetitions
+ [SecondFour]: A named capture group. [\d{4}]
+ Any digit, exactly 4 repetitions
+ \s*$
+ Whitespace, any number of repetitions
+ End of line or string
+
+
+
+ The SQL representation of null
+
+
+ The HTML representation of a non-breaking space
+
+
+ The name of the connection string used by default in our products (and DotNetNuke).
+
+
+ A regular expression which captures any characters that are invalid for a CSS class
+
+
+ A regular expression to match an XML tag (i.e. <thing> or </widget>)
+
+ <
+ Any character that is NOT in this class: [>], any number of repetitions
+ >
+
+
+
+ A regular expression to match an XML entity (i.e. & or Lj)
+
+ &
+ Any character that is NOT in this class: [;], any number of repetitions
+ ;
+
+
+
+ Escapes quotes in a SQL string.
+ The string value to escape.
+ with quotes escaped for SQL
+
+
+ Determines whether the specified is null, empty, or only whitespace.
+ The value to test.
+ true if the specified value is not null, empty, or only whitespace; otherwise, false.
+
+
+
+ When setting the of control, spaces are incorrectly encoded.
+ Use this method to correctly encode the full image path before setting the property.
+
+ A possible workaround from Microsoft:
+
Thanks for reporting this issue. It is actually the combination of 3 issues in ASP.NET and IIS:
+
+
By default, IIS does not allow URLs to contain "+" characters, whether encoded or not (http://blogs.iis.net/thomad/archive/2007/12/17/iis7-rejecting-urls-containing.aspx). To allow this character, set in web.config.
+
The ASP.NET method HttpServerUtility.UrlEncode() does not escape the "%" character. This is by design, since we don't want to double-escape percent characters. That is, we want to allow things like HttpServerUtillity.UrlEncode("http://www.foo.com/foo%20bar.aspx"). However, System.Uri.EscapeUriString() does escape the "%" character, so you should use this method when you want to escape the "%" character.
+
Neither HttpServerUtility.UrlEncode() nor System.Uri.EscapeUriString() escape the "#" character. This is by design, since the "#" character separates the fragment from the rest of the URL. Since these APIs just take an arbitrary string, they cannot know whether you want to escape the "#" character or not, and they decided to not escape it (which is the most common case). The workaround is to manually escape the "#" character if needed.
+
+ So the complete workaround for this bug is to allow the "+" character in IIS, use System.Uri.EscapeUriString() instead of HttpServerUtility.UrlEncode(), and manually escape the "#" character.
+
+
+ The file path.
+ The file path correctly encoded for the image tag's src attribute.
+
+
+ Validates the given email address.
+ The email address to validate.
+ Whether the specified email address is in a valid format.
+
+
+ Validates an email address, or multiple comma-delimited email addresses.
+ The email address or addresses to validate.
+ if set to true, could be multiple, comma-delimited email addresses,
+ otherwise it must be a single email address.
+ Whether the specified email address or addresses are in a valid format.
+
+
+ Validates a phone number against .
+ The phone number to validate.
+ Whether the specified phone number is in a valid format.
+
+
+ Determines whether the specified is an integer value. Uses .
+ The string to check.
+ true if the specified is an integer; otherwise, false.
+
+
+ Determines whether the specified is an integer value.
+ The string to check.
+ The culture to use when trying to parse the integer.
+ true if the specified is an integer; otherwise, false.
+
+
+ Determines whether the specified is a boolean value. Uses .
+ The string to check.
+ true if the specified is a boolean; otherwise, false.
+
+
+ Splits text into a list, allowing whitespace, comma, and semicolon as delimiters.
+ The text list.
+ An array containing the non-empty entries of the .
+
+
+ Parses a into a of . Uses .
+ A which is a list of integers.
+ A of the values in parsed as s.
+ If any value is not an integer
+
+
+ Parses a into a of .
+ A which is a list of integers.
+ The culture to use when parsing each entry in
+ A of the values in parsed as s.
+ If any value is not an integer
+
+
+ Parses a array into a of . Uses .
+ A array of integer values.
+ A of the values in parsed as s.
+ If any value is not an integer
+
+
+ Parses a array into a of .
+ A array of integer values.
+ The culture to use when parsing each in
+ A of the values in parsed as s.
+ If any value is not an integer
+
+
+ Parses a string, converting to a if possible using , otherwise returning null.
+ The string to parse.
+ as a DateTime, if possible, otherwise null
+
+
+ Parses a string, converting to a if possible, otherwise returning null.
+ The date value.
+ The culture to use when parsing the .
+ as a DateTime, if possible, otherwise null
+
+
+ Converts the string representation of a GUID to the equivalent structure.
+ The GUID to convert.
+ The structure that will contain the parsed result.
+ true if the parse operation was successful; otherwise, false.
+ This method returns false if is null or not in a recognized format, and does not return an exception.
+ Documentation based on http://msdn.microsoft.com/en-us/library/system.guid.tryparse%28VS.100%29.aspx
+
+
+ Gets a random number to use as a seed.
+ A random number seed
+
+
+ Gets a random number generator.
+ A new, properly initialized instance of the class.
+
+
+ Compares two s for equality, using the Invariant Culture and ignoring case.
+ The first value.
+ The second value.
+ true if is the same as (without regard to case); otherwise false.
+
+
+ Compares two s for equality, using given and ignoring case.
+ The first value.
+ The second value.
+ The culture to use in determining case insensitivity.
+ true if is the same as (without regard to case); otherwise false
+
+
+ Serializes the specified value as binary data into a byte array.
+ The value to be serialized.
+ A byte array representing the value in binary formatting
+
+
+ Deserializes the data into an object.
+ The data to deserialize.
+ An object represented in binary formatting in the given byte array
+
+
+ Determines whether the specified control's CssClass property contains the given CSS class.
+ The control to check.
+ Name of the CSS class.
+ true if the specified control contains the given CSS class; otherwise, false.
+ is null.
+
+
+ Determines whether the specified control's CssClass property contains the given CSS class.
+ The control to check.
+ Name of the CSS class.
+ true if the specified control contains the given CSS class; otherwise, false.
+ is null.
+
+
+ Adds the given CSS class to the specified control's CssClass property if not already present.
+ The control.
+ Name of the CSS class to add.
+
+
+ Adds the given CSS class to the specified control's CssClass property if not already present.
+ The control.
+ Name of the CSS class to add.
+ The specified control's CssClass property with the appended.
+
+
+ Removes the given CSS class from the specified control's CssClass property, if it is present.
+ The control.
+ Name of the CSS class to remove.
+ is null.
+
+
+ Removes the given CSS class from the specified control's CssClass property, if it is present.
+ The control.
+ Name of the CSS class to remove.
+ The specified control's CssClass property without in the list.
+
+ is null.
+ is null.
+
+
+ Toggles a CSS class in the specified control's CssClass property; i.e. removes it if it is present, and adds it if it is missing.
+ The control.
+ Name of the CSS class to toggle.
+ is null.
+
+
+ Toggles a CSS class in the specified control's CssClass property; i.e. removes it if it is present, and adds it if it is missing.
+ The control.
+ Name of the CSS class to toggle.
+ The specified control's CssClass property without in the list if it was present, or with if it was not already in the list.
+
+
+ Registers a script to display error messages from server-side validation as the specified or loads from a postback.
+ The or which is being posted back.
+ Must be called in the PreRender if used to validate against the Text property of DNNTextEditor controls, otherwise Text will not be populated.
+ Must set the ErrorMessage manually if using a resourcekey, otherwise the resourcekey will not have overridden the ErrorMessage property.
+
+
+ Registers a script to display error messages from server-side validation as the specified or loads from a postback.
+ The or which is being posted back.
+ The validation group against which to validate.
+ Must be called in the PreRender if used to validate against the Text property of DNNTextEditor controls, otherwise Text will not be populated.
+ Must set the ErrorMessage manually if using a resourcekey, otherwise the resourcekey will not have overridden the ErrorMessage property.
+
+
+ Find all child controls recursively.
+ The root control, not included in returned values.
+ Enumerable of s
+
+
+ Finds the first with the given .
+ Searches through all levels of the
+ The outermost containing in which to search.
+ The ID of the being sought, set in
+ The first with the given that is contained by .
+ from http://www.codinghorror.com/blog/archives/000307.html
+ is null.
+
+
+ Traverses the control hierarchy the given control to find a parent control with the given type ,
+ or null if none exists.
+ The type of parent for which to search
+ The child control for whose parent to search.
+ A parent of with type , or null if none exists.
+
+
+ Gets the response from the given URL as a string.
+ The URL to get the response from.
+ The response from the given URL
+ Unable to read HTML from the specified URL
+
+
+ Converts the given value to be "slug-appropriate," i.e. removes diacritics from letters,
+ replaces non-alphanumeric chatracters with - (without allowing multiple - in a row).
+ The value to convert.
+ The value after going through the conversion process
+
+
+ Removes the diacritics from the given string.
+ The value from which to strip diacritics.
+ without any diacritics
+ Based on http://blogs.msdn.com/b/michkap/archive/2007/05/14/2629747.aspx
+ is null.
+
+
+ Removes entities and tags from
+ The value from which to remove markup
+ Whether to replace with a space or an empty
+ with any markup removed
+
+
+ Removes any XML/HTML entities ( , <, etc.)
+ Value from which to remove entities
+ Whether to replace entities with spaces or just remove
+ with any entities removed
+ value
+
+
+ Removes XML/HTML tags (<....>)
+ Value from which to remove tags
+ Whether to replace entities with spaces or just remove
+ with any tags removed
+ value
+
+
+ Transforms the given into an absolute URL.
+ The URL on which to base the absolute URL (probably ).
+ The URL to transform.
+ An absolute URL
+
+
+ Transforms the given into an absolute URL.
+ The page of the current request.
+ The URL to transform.
+ An absolute URL
+ is null.
+
+
+ Transforms the given into an absolute URL.
+ The page of the current request.
+ The URL on which to base the absolute URL (probably ).
+ The URL to transform.
+ An absolute URL
+ page;A page parameter must be supplied when calling MakeUrlAbsolute with a ~/ rooted path
+
+
+ Combines the given hash codes into a single unique hash value.
+ The hash values to combine.
+ A hash code comprised of the given
+ is null.
+
+
+ Gets the entry hash for an object.
+ The entry.
+ An object's entry hash
+
+
+ Combines the hash codes of the given objects into a single unique hash value.
+ The objects whose has values to combine.
+ A hash code comprised of the given ' hash codes
+ is null.
+
+
+ Combines the given hash codes into a single unique hash value.
+ The first hash code.
+ The second hash code.
+ A hash code comprised of the given hashes
+
+
+ Combines the given hash codes into a single unique hash value.
+ The first hash code.
+ The second hash code.
+ The third hash code.
+ A hash code comprised of the given hashes
+
+
+ Combines the given hash codes into a single unique hash value.
+ The first hash code.
+ The second hash code.
+ The third hash code.
+ The fourth hash code.
+ A hash code comprised of the given hashes
+
+
+ Combines the given hash codes into a single unique hash value.
+ The first hash code.
+ The second hash code.
+ The third hash code.
+ The fourth hash code.
+ The fifth hash code.
+ A hash code comprised of the given hashes
+
+
+ Combines the hash codes of the given objects into a single unique hash value.
+ The first object.
+ The second object.
+ A hash code comprised of the given objects' hash codes
+ or is null.
+
+
+ Combines the hash codes of the given objects into a single unique hash value.
+ The first object.
+ The second object.
+ The third hash code.
+ A hash code comprised of the given objects' hash codes
+ , , or is null.
+
+
+ Combines the hash codes of the given objects into a single unique hash value.
+ The first object.
+ The second object.
+ The third hash code.
+ The fourth hash code.
+ A hash code comprised of the given objects' hash codes
+ , , , or is null.
+
+
+ Combines the hash codes of the given objects into a single unique hash value.
+ The first object.
+ The second object.
+ The third hash code.
+ The fourth hash code.
+ The fifth hash code.
+ A hash code comprised of the given objects' hash codes
+ , , , , or is null.
+
+
+ Creates a SQL parameter of the given .
+ Sets the value to if is null.
+ The type of the (value-type) parameter value
+ SQL column type of the parameter.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value, and type.
+
+
+ Creates a SQL parameter of the given .
+ Sets the value to if is null.
+ The type of the (reference-type) parameter value
+ SQL column type of the parameter.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value, and type.
+
+
+ Creates a () SQL parameter, without size bounds.
+ Sets the value to if is null.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value, and type.
+
+
+ Creates a () SQL parameter, without size bounds.
+ Sets the value to if is null.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value, and type.
+
+
+ Creates a () SQL parameter, setting and checking the bounds of the value within the parameter.
+ Sets the value to if is null.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ The size of the field in the database.
+ A SqlParameter with the correct value, type, and capacity.
+
+
+ Creates a () SQL parameter, without size bounds.
+ Sets the value to if is null.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value, and type.
+
+
+ Creates a () SQL parameter, setting and checking the bounds of the value within the parameter.
+ Sets the value to if is null.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ The size of the field in the database.
+ A SqlParameter with the correct value, type, and capacity.
+
+
+ Creates a () SQL parameter,
+ setting the value to if is
+ or without a value.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value and type.
+
+
+ Creates a () SQL parameter, setting the value to if is its initial value,
+ , , or without a value.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value and type.
+
+
+ Creates a () SQL parameter, setting the value to if is null or empty.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value and type.
+
+
+
+ Creates an () SQL parameter, setting the value to if is
+ , , or without a value.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value and type.
+
+
+ Creates a () SQL parameter, setting the value to if is
+ , , or without a value.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A SqlParameter with the correct value and type.
+
+
+ Creates a () SQL parameter, setting the value to
+ if is without a value.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A with the correct value and type.
+
+
+ Creates a ( SQL parameter, setting the value to if is ,
+ , or without a value.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A with the correct value and type.
+
+
+ Creates a [] () SQL parameter, setting the value to if is null, or an empty array.
+ Name of the parameter in the SQL Stored Procedure.
+ The value of the parameter.
+ A with the correct value and type.
+
+
+
+ Gets a connection to the database specified in the given .
+
+ Name of the connection string.
+ A connection to the database
+ The key was not found in the config file
+
+
+
+ Gets a connection to the database specified in
+
+ A connection to the database
+
+
+
+ Executes the SQL string against the default database connection, and builds an with the .
+
+ The SQL to execute.
+ An of the results from the SQL execution
+ An error happens while executing the SQL
+
+
+
+ Executes the SQL statement against the default database connection, and returns the number of rows affected
+
+ The SQL to execute.
+ The number of rows affected by the execution of the SQL script
+ An error happens while executing the SQL
+
+
+
+ Executes the SQL string against the default database connection, and builds a . Sets to .
+
+ The SQL to execute.
+ A of the results from the SQL execution
+
+
+
+ Executes the SQL string against the default database connection, and builds a .
+
+ The SQL to execute.
+ The culture of the returned.
+
+ A of the results from the SQL execution
+
+ An error happens while executing the SQL
+
+
+
+ Gets a for the default database connection.
+
+ A for the default database connection
+
+
+ Gets a value indicating whether the current web user is logged in to the current website, or false if this is called outside of a website request.
+ true if this is called in a web request and the current user is logged in; otherwise, false.
+
+
+ Extension methods for dealing with , and related types
+
+
+ Converts an to an
+ The node to convert
+ A new instance
+ based on
+
+
+ Converts an to an
+ The element to convert
+ A new instance
+ based on
+
+
+ Converts an to an
+ The element to convert
+ A new instance
+ based on
+
+
+ Converts an to an
+ The document to convert
+ A new instance
+ based on
+
+
+ Converts an to an
+ The document to convert
+ A new instance
+ based on
+
+
+
+
+
+
+
+
+ Summary description for ObjectViewerCtl.
+
+
+
+
+ Required designer variable.
+
+
+
+
+ Clean up any resources being used.
+
+
+
+
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+
+
+
+
+ Summary description for Version.
+
+
+
+
+ Summary description for SystemAttributesView.
+
+
+
+
+ Required designer variable.
+
+
+
+
+ Clean up any resources being used.
+
+
+
+
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+
+
+
+
diff --git a/Source/References/Framework/Engage.Framework.dll b/Source/References/Framework/Engage.Framework.dll
index fa180bd..ce88c93 100644
Binary files a/Source/References/Framework/Engage.Framework.dll and b/Source/References/Framework/Engage.Framework.dll differ
diff --git a/Source/References/Telerik.Web.Design.dll b/Source/References/Telerik.Web.Design.dll
deleted file mode 100644
index 17c0755..0000000
Binary files a/Source/References/Telerik.Web.Design.dll and /dev/null differ
diff --git a/Source/References/Telerik.Web.UI.dll b/Source/References/Telerik.Web.UI.dll
deleted file mode 100644
index f475b1f..0000000
Binary files a/Source/References/Telerik.Web.UI.dll and /dev/null differ
diff --git a/Source/References/Telerik.Web.UI.xml b/Source/References/Telerik.Web.UI.xml
deleted file mode 100644
index 451af43..0000000
--- a/Source/References/Telerik.Web.UI.xml
+++ /dev/null
@@ -1,98323 +0,0 @@
-
-
-
- Telerik.Web.UI
-
-
-
-
-
-
-
-
- Describes an object that can be used to resolve references to a control by its ID
-
-
-
-
- Resolves a reference to a control by its ID
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
-
-
-
-
- Registers the control with the ScriptManager
-
-
-
-
- Registers the CSS references
-
-
-
-
- Loads the client state data
-
-
-
-
-
- Saves the client state data
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the names of all embedded skins. Used by Telerik.Web.Examples.
-
-
-
-
- Executed when post data is loaded from the request
-
-
-
-
-
-
-
- Executed when post data changes should invoke a chagned event
-
-
-
-
- Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
-
-
-
- If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.
-
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
-
-
- For internal use.
-
-
-
-
- Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
-
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
-
- Gets the real skin name for the control user interface. If Skin is not set, returns
- "Default", otherwise returns Skin.
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
-
-
-
-
-
- The CssClass property will now be used instead of the former Skin
- and will be modified in AddAttributesToRender()
-
-
- protected override string CssClassFormatString
- {
- get
- {
- return "RadDock RadDock_{0} rdWTitle rdWFooter";
- }
- }
-
-
-
-
-
-
-
-
-
-
-
-
- For internal use
-
-
-
-
-
-
- Base control used to contain a template. Ensures that if the template
- has been instantiated or the Controls collection has been accessed
- the template cannot be set again.
-
-
- 1) Into an existing WebControl add a readonly property and
- a member for the template container
-
- private SingleTemplateContainer _contentContainer;
-
- [Browsable(false)]
- public SingleTemplateContainer ContentContainer
- {
- get
- {
- EnsureChildControls();
- return _contentContainer;
- }
- }
-
- 2) Override CreateChildControls() and instantiate the SingleTemplateContainer.
- The parameter is a reference to the instantiating control (used when throwing exceptions).
-
- protected override void CreateChildControls()
- {
- base.CreateChildControls();
-
- _contentContainer = new SingleTemplateContainer(this);
- _contentContainer.ID = "Content";
- Controls.Add(_contentContainer);
- }
-
- 3) Add read/write property for the template. You will need the TemplateContainer
- attribute in case if you override SingleTemplateContainer in order to add
- properties, accessible during the databinding.
-
- //[TemplateContainer(typeof(SingleTemplateContainer))]
- [PersistenceMode(PersistenceMode.InnerProperty)]
- [TemplateInstance(TemplateInstance.Single)]
- [Browsable(false)]
- public ITemplate ContentTemplate
- {
- get
- {
- EnsureChildControls();
- return ContentContainer.Template;
- }
- set
- {
- EnsureChildControls();
- ContentContainer.Template = value;
- }
- }
-
-
-
-
-
- Instantiates a new instance of SingleTemplateContainer.
-
-
- The control which contains the template. This parameter is used when
- SingleTemplateContainer throws exceptions.
-
-
-
-
- cssLinkFormat is used when registering css during ajax requests or when the page header is not runat="server".
-
-
-
-
- the registerSkins() method is in Core.js
-
-
-
-
- Returns the skin that should be applied to the control.
-
-
-
-
- Returns the web.config value which specifies the application-wide Skin setting.
-
-
- Telerik.[ShortControlName].Skin or Telerik.Skin, depending on which value was set.
-
-
-
-
- Registers the common skin CSS file and the CSS files, associated with the selected skin.
-
-
-
-
- Registers a Css file reference on the page
-
- reference to the page
- reference to the control
- the css file url
-
-
-
- Returns the attributes for the common skin CSS file and the CSS files, associated with the selected skin.
-
-
-
-
- Returns the attributes for all embedded skins.
-
-
-
-
- Returns the names of all embedded skins. The common skin attribute is not included!
-
-
-
-
- Allows the mapping of a property declared in managed code to a property
- declared in client script. For example, if the client script property is named "handle" and you
- prefer the name on the TargetProperties object to be "Handle", you would apply this attribute with the value "handle."
-
-
-
-
- Creates an instance of the ClientPropertyNameAttribute and initializes
- the PropertyName value.
-
- The name of the property in client script that you wish to map to.
-
-
-
- The name of the property in client script code that you wish to map to.
-
-
-
-
- Associates a client script resource with an extender class.
- This allows the extender to find it's associated script and what
- names and prefixes with which to reference it.
-
-
-
-
- Called from other constructors to set the prefix and the name.
-
- The name given to the class in the Web.TypeDescriptor.addType call
-
-
-
- Associates a client script resource with the class.
-
- The name given to the class in the Web.TypeDescriptor.addType call
- A Type that lives in the same folder as the script file
- The name of the script file itself (e.g. 'foo.cs')
-
-
-
- Associates a client script resource with the class.
-
- The name given to the class in the Web.TypeDescriptor.addType call
- The name of the script resource, e.g. 'ControlLibrary1.FooExtender.Foo.js'
-
-
-
- The component type name to use when referencing the component class in XML. If
- the XML reference is "<myns:Foo/>", the component type is "Foo".
-
-
-
-
- This is the path to the resource in the assembly. This is usually defined as
- [default namespace].[Folder name].FileName. In a project called "ControlLibrary1", a
- JScript file called Foo.js in the "Script" subdirectory would be named "ControlLibrary1.Script.Foo.js" by default.
-
-
-
-
- Signifies that this property references a ScriptComponent
-
-
-
-
- Repository of old "Atlas" code that we're waiting to have integrated into the new Microsoft Ajax Library
-
-
-
-
- Specifies this property is an element reference and should be converted during serialization.
- The default (e.g. cases without this attribute) will generate the element's ID
-
-
-
-
- Constructs a new ElementReferenceAttribute
-
-
-
-
- Signifies that this Property should be exposed as a client-side event reference
-
-
-
-
- Initializes a new ClientControlEventAttribute
-
-
-
-
- Initializes a new ClientControlEventAttribute
-
-
-
-
-
- Tests for object equality
-
-
-
-
-
-
- Gets a hash code for this object
-
-
-
-
-
- Gets whether this is the default value for this attribute
-
-
-
-
-
- Whether this is a valid ScriptEvent
-
-
-
-
- Signifies that this method should be exposed as a client callback
-
-
-
-
- Initializes a new ClientControlMethodAttribute
-
-
-
-
- Initializes a new ClientControlMethodAttribute
-
-
-
-
-
- Tests for object equality
-
-
-
-
-
-
- Gets a hash code for this object
-
-
-
-
-
- Gets whether this is the default value for this attribute
-
-
-
-
-
- Whether this is a valid ScriptMethod
-
-
-
-
- Signifies that this property is to be emitted as a client script property
-
-
-
-
- Initializes a new ClientControlPropertyAttribute
-
-
-
-
- Initializes a new ClientControlPropertyAttribute
-
-
-
-
-
- Tests for object equality
-
-
-
-
-
-
- Gets a hash code for this object
-
-
-
-
-
- Gets whether this is the default value for this attribute
-
-
-
-
-
- Whether this property should be exposed to the client
-
-
-
-
- Describes an object which supports ClientState
-
-
-
-
- Loads the client state for the object
-
-
-
-
-
- Saves the client state for the object
-
-
-
-
-
- Whether ClientState is supported by the object instance
-
-
-
-
- Defines the common property categories' names
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
-
-
-
-
- Registers the control with the ScriptManager
-
-
-
-
- Registers the CSS references
-
-
-
-
- Loads the client state data
-
-
-
-
-
- Saves the client state data
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the names of all embedded skins. Used by Telerik.Web.Examples.
-
-
-
-
- Executed when post data is loaded from the request
-
-
-
-
-
-
-
- Executed when post data changes should invoke a chagned event
-
-
-
-
- Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
-
-
-
- If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.
-
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
-
- For internal use.
-
-
-
-
- Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
-
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
-
- Gets the real skin name for the control user interface. If Skin is not set, returns
- "Default", otherwise returns Skin.
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
-
-
-
-
-
- The CssClass property will now be used instead of the former Skin
- and will be modified in AddAttributesToRender()
-
-
- protected override string CssClassFormatString
- {
- get
- {
- return "RadDock RadDock_{0} rdWTitle rdWFooter";
- }
- }
-
-
-
-
-
-
-
-
- The presence of this attribute on a property of a subclass of
- TargetControlPropertiesBase indicates that the property value is
- required and the control can not be used without it. Absence of a
- required property value causes an exception to be thrown during
- creation of the control.
-
-
-
-
- Constructs a new RequiredPropertyAttribute
-
-
-
-
- Gets the script references for a type
-
-
-
-
- Describes an object to a IScriptDescriptor based on its reflected properties and methods
-
- The object to be described
- The script descriptor to fill
- The object used to resolve urls
- The object used to resolve control references
-
-
-
- Gets the script references for a type
-
-
-
-
-
-
- Gets the script references for a type
-
-
-
-
-
-
-
- Gets the embedded css file references for a type
-
-
-
-
-
-
- Register's the Css references for this control
-
-
-
-
-
- Executes a callback capable method on a control
-
-
-
-
-
-
-
- ScriptReference objects aren't immutable. The AJAX core adds context to them, so we cant' reuse them.
- Therefore, we track only ReferenceEntries internally and then convert them to NEW ScriptReference objects on-demand.
-
-
-
-
-
-
- Gets the script references for a type and walks the type's dependencies with circular-reference checking
-
-
-
-
-
-
-
- Gets the css references for a type and walks the type's dependencies with circular-reference checking
-
-
-
-
-
-
-
-
- Represents the Close command item in a RadDock control.
-
-
-
-
- Represents a custom command item in a RadDock control.
-
-
-
-
- Initializes a new instance of the DockCommand class
-
-
-
-
- Initializes a new instance of the DockCommand class with the specified
- clientTypeName, cssClass, name, text and autoPostBack
-
-
-
-
- Creates an HtmlAnchor control with applied CssClass and Title
-
- An HtmlAnchor control
-
-
-
- Returns the value of the CssClass property. This method should be overriden
- in multistate commands, such as DockToggleCommand, to return one of the
- CssClass and AlternateCssClass properties, depending on the command state.
-
-
-
-
- Returns the value of the Text property. This method should be overriden
- in multistate commands, such as DockToggleCommand, to return one of the
- Text and AlternateText properties, depending on the command state.
-
-
-
-
- Specifies the name of the type of the client object, which
- will be instantiated when the command is initialized for the first time.
-
-
-
-
- Specifies the name of the command. The value of this property is used
- to determine on the server which command was clicked on the client.
-
-
-
-
- Specifies the text, which will be displayed as tooltip when the user
- hovers the mouse cursor over the command button.
-
-
-
-
- Gets or sets a value indicating whether a postback to the server
- automatically occurs when the user drags the RadDock control.
-
-
-
-
- Gets or sets the client-side script that executes when the Command event is raised
- on the client.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class rendered by the Command item
- on the client.
-
-
-
-
- Initializes a new instance of the DockCloseCommand class
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- A collection of DockCommand objects in a RadDock control.
-
-
-
-
- Appends a DockCommand to the end of the collection
-
-
-
-
- Inserts a DockCommand to a given index in the collection
-
-
-
-
- Provides data for the DockCommand event.
-
-
-
-
- Gets the DockCommand item which initiated the event.
-
-
-
-
- Represents the method that handles a DockCommand event
-
- The source of the event
- A DockCommandEventArgs that contains the event data
-
-
-
- Represents the ExpandCollapse command item in a RadDock control.
-
-
-
-
- Represents a two state command item in a RadDock control.
-
-
-
-
- Initializes a new instance of the DockToggleCommand class
-
-
-
-
- Initializes a new instance of the DockToggleCommand class with the specified
- clientTypeName, cssClass, alternateCssClass, name, text, alternateText and autoPostBack
-
-
-
-
- Returns the value of the CssClass property if the value of the State
- property is Primary, otherwise AlternateCssClass.
-
-
-
-
- Returns the value of the Text property if the value of the State property is
- Primary, otherwise AlternateText.
-
-
-
-
- Gets or sets the initial state of the command item. If the value of this property
- is Primary, the values of the Text and CssClass properties will be used initially,
- otherwise the command will use AlternateText and AlternateCssClass.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class rendered by the Command item
- on the client when State is Alternate.
-
-
-
-
- Specifies the text, which will be displayed as tooltip when the user
- hovers the mouse cursor over the command button when State is Alternate.
-
-
-
-
- Initializes a new instance of the DockExpandCollapseCommand class
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Implements methods, needed by RadDock or RadDockZone to register with
- a control which will take care of the dock positions.
-
-
-
-
- Each dock will use this method in its OnInit event to register
- with the IDockLayout. This is needed in order the layout to
- be able to manage the dock position, set on the client.
-
-
-
-
- Each dock will use this method in its OnUnload event to unregister
- with the IDockLayout. This is needed in order the layout to
- be able to manage the dock state properly.
-
-
-
-
- Each zone will use this method in its OnInit event to register
- with the IDockLayout. This is needed in order the layout to
- be able to manage the dock positions, set on the client.
-
-
-
-
- Each zone will use this method in its OnUnload event to unregister
- with the IDockLayout.
-
-
-
-
- Docks the RadDock control inside a child zone with ID=newParentClientID
-
-
-
-
- RadDock is a control, which enables the developers to move, dock,
- expand/collapse any DHTML/ASP.NET content
-
-
-
-
- Raises the DockPositionChanged event.
-
-
- This method notifies the server control that it should perform actions to
- ensure that it should be docked in the specified RadDockZone on the client.
-
-
-
-
- Raises the Command event and allows you to handle the Command event directly.
-
-
-
-
- Docks the RadDock control in the zone with ClientID equal to dockZoneID.
-
-
- The RadDock control should be placed into a RadDockLayout in order this
- method to work. It is not necessary the layout to be direct parent of the
- RadDock control.
-
- The ClientID of the RadDockZone control, where
- the control should be docked.
-
-
-
- Docks the RadDock control in the specified RadDockZone.
-
- The RadDockZone control where the control should be docked.
-
-
-
- Removes the RadDock control from its parent RadDockZone.
-
-
-
-
- Returns the unique name for the dock, based on the UniqueName and
- the ID properties.
-
-
- A string, containing the UniqueName property of the dock, or its
- ID, if the UniqueName property is not set.
-
-
-
-
- Returns a DockState object, containing data about the current state
- of the RadDock control.
-
- A DockState object, containing data about the current state
- of the RadDock control. This object could be passed to ApplyState()
- method.
-
-
-
-
- Applies the data from the supplied DockState object.
-
-
- A DockState object, containing data about the state, which should
- be applied on the RadDock control.
-
-
-
-
- Overriden. Handles the Init event. Inherited from WebControl.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets a value, indicating whether the control will initiate postback
- when it is docked/undocked or its position changes.
-
-
-
-
- Gets or sets a value, indicating whether the control is closed (style="display:none;").
-
-
- When the value of this property is true, the control will be hidden, but its HTML will
- be rendered on the page
-
-
-
-
- Gets or sets the tooltip of the CloseCommand when the corresponding
- property was not explicitly set on the command object.
-
-
-
-
- Gets or sets a value, indicating whether the control is collapsed.
-
-
- When the value of this property is true, the content area of the control
- will not be visible.
-
-
-
-
- Gets or sets the tooltip of the ExpandCollapseCommand when the dock
- is not collapsed and the corresponding property was not explicitly set
- on the command object.
-
-
-
-
- Gets a collection of DockCommand objects representing the individual commands within the control titlebar.
-
-
- A DockCommandCollection that contains a collection of DockCommand objects representing the individual commands within the control titlebar.
-
-
- Use the Commands collection to programmatically control the commands buttons within the control titlebar.
-
-
-
-
- Gets or sets a value, indicating whether the control will initiate postback
- when its command items are clicked.
-
-
-
-
- Gets the control, where the ContentTemplate will be instantiated in.
-
-
- You can use this property to programmatically add controls to the content area. If you add controls
- to the ContentContainer the Text property will be ignored.
-
-
-
-
- Gets or sets the System.Web.UI.ITemplate that contains the controls which will be
- placed in the control content area.
-
-
- You cannot set this property twice, or when you added controls to the ContentContainer. If you set
- ContentTemplate the Text property will be ignored.
-
-
-
-
- Gets or sets the value, defining the commands which will appear
- in the RadDock titlebar when the commands collection is not modified.
-
-
-
-
- Gets or sets the value, defining the behavior of the control titlebar and grips.
-
-
-
-
- Gets or sets a value, indicating whether the control could be left undocked.
-
-
-
-
- Gets the ClientID of the RadDockZone, where the control is docked. When the control is undocked,
- this property returns string.Empty.
-
-
-
-
- Gets or sets a value, indicating whether the control will have animation.
-
-
- When the value of this property is true, the RadDock will be moved, expanded, collapsed,
- showed and hide with animations
-
-
-
-
- Gets or sets a value, indicating whether the control could be dragged.
-
-
- When the value of this property is true, the control could be dragged with the mouse
-
-
-
-
- Gets or sets a value, indicating whether the control will be with rounded corners.
-
-
- When the value of this property is true, the control will have rounded corners.
-
-
-
-
- Gets or sets the tooltip of the ExpandCollapseCommand when the dock
- is collapsed and the corresponding property was not explicitly set
- on the command object.
-
-
-
-
- Specifies the UniqueNames of the RadDockZone controls, where
- the RadDock control will not be allowed to dock.
-
-
-
-
- Gets or sets the height of the RadDock control
-
-
-
-
- Gets or sets the expanded height of the RadDock control
-
-
-
-
- Gets the position of the RadDock control in its parent zone. If undocked returns -1.
-
-
-
-
-
-
-
-
- Gets or sets the horizontal position of the RadDock control in pixels. This
- property is ignored when the RadDock control is docked into a RadDockZone.
-
-
-
-
- Gets or sets the client-side script that executes when a RadDock Command event is raised
-
-
-
-
- Gets or sets the client-side script that executes when a RadDock DragStart event is raised
-
-
-
-
- Gets or sets the client-side script that executes when a RadDock DragEnd event is raised
-
-
-
-
- Gets or sets the client-side script that executes when a RadDock Drag event is raised
-
-
-
-
- Gets or sets the client-side script that executes when the RadDock control changes its position
-
-
-
-
- Gets or sets the client-side script that executes when the RadDock control is dropped on to a zone
- before it changes its position
-
-
-
-
- Gets or sets the client-side script that executes after the RadDock client-side obect initializes
-
-
-
-
- Gets or sets the client-side script that executes when a RadDock ResizeStart event is raised
-
-
-
-
- Gets or sets the client-side script that executes when a RadDock ResizeEnd event is raised
-
-
-
-
- Gets or sets a value, indicating whether the control is resizable.
-
-
- When the value of this property is true, the control will be resizable
-
-
-
-
- Gets or sets a value, indicating whether the control is pinned.
-
-
- When the value of this property is true, the control will retain its position
- if the page scrolled.
-
-
-
-
- Gets or sets the tooltip of the PinUnpinCommand when the dock
- is not pinned and the corresponding property was not explicitly set
- on the command object.
-
-
-
-
- Gets or sets the additional data, which could be saved in the DockState.
-
-
-
-
- Gets or sets the text which will appear in the control content area. If the ContentTemplate
- or the ContentContainer contain any controls, the value of this property is ignored.
-
-
-
-
- Gets or sets the text which will appear in the control titlebar area. If the TitlebarTemplate
- or the TitlebarContainer contain any controls, the value of this property is ignored.
-
-
-
-
- Gets the control, where the TitlebarTemplate will be instantiated in.
-
-
- You can use this property to programmatically add controls to the titlebar. If you add controls
- to the TitlebarContainer the Title property will be ignored.
-
-
-
-
- Gets or sets the System.Web.UI.ITemplate that contains the controls which will be
- placed in the control titlebar.
-
-
- You cannot set this property twice, or when you added controls to the TitlebarContainer. If you set
- TitlebarTemplate the Title property will be ignored.
-
-
-
-
- Gets or sets the vertical position of the RadDock control in pixels. This
- property is ignored when the RadDock control is docked into a RadDockZone.
-
-
-
-
- Gets or sets the unique name of the control, which allows the parent RadDockLayout to
- automatically manage its position. If this property is not set, the control ID will be
- used instead. RadDockLayout will throw an exception if it finds two RadDock controls with
- the same UniqueName.
-
-
-
-
- Gets or sets the tooltip of the PinUnpinCommand when the dock
- is pinned and the corresponding property was not explicitly set
- on the command object.
-
-
-
-
- Gets or sets the width of the RadDock control
-
-
-
-
- Occurs when the control is docked in another RadDockZone, or its
- in its current zone position was changed.
-
-
- Notifies the server control to perform the needed actions to ensure that
- it should be docked in the specified RadDockZone on the client.
-
-
-
-
- Occurs when a command is clicked.
-
-
- The event handler receives an argument of type DockCommandEventArgs containing
- data related to this event.
-
-
-
-
-
-
-
-
-
-
-
-
- Workflow:
- 1). OnInit - ensure that the framework will call TrackViewState, LoadViewState and SaveViewState.
- We expect that all child docks will be created here.
- 2). TrackViewState - raise LoadDockLayout event in order to let the developer to supply
- the initial parents of the registered docks, because the docks could be created with
- different parents than needed.
- 2a). LoadViewState - loads and applies the dock parents from the ViewState in order to persist
- the dock positions between the page postbacks.
- 3). LoadPostData - returns true to ensure that RaisePostDataChangedEvent()
- 3a). Dock_DockZoneChanged - this event is raised by each dock in its LoadPostData method.
- We handle this event and store the pair UniqueName/NewDockZoneID in the _clientPositions
- Dictionary. This Dictionary will be used in #4.
- 4). RaisePostDataChangedEvent - sets the parents of the registered docks according their
- positions, set on the client. These positions are stored in the _clientPositions Dictionary.
- 5). OnLoad, other events, such as Click, Command, etc. If you create a dock here it will be
- rendered on the page, but if it is not recreated in the next OnInit, it will not persist
- its position, set on the client!
- 6). SaveViewState - stores the dock parents in the ViewState in order to persist their positions
- between the page postbacks.
- 7). Page_SaveStateComplete - raises the SaveDockLayout event to let the developer to save
- the state in a database or other storage medium.
- Note: The dock parents will be stored in the ViewState if StoreLayoutInViewState is set
- to true (default). Otherwise the developer should take care of the dock positions when the page
- is posted back.
-
-
-
-
- Overriden. Handles the Init event. Inherited from Control.
-
-
-
-
- The docks must be already created. We will apply their order
- and if there is a state information, we will apply it.
-
-
-
-
- We will apply the dock positions saved in the ViewState here.
-
-
-
-
- Overridden. Raises the PreRender event
-
-
-
-
-
-
-
-
- We will loop through all registered docks and will retrieve their
- positions and state. Those positions will be saved in the ViewState
- if StoreLayoutInViewState is true.
-
- base.SaveViewState()
-
-
-
- Reorders the docks in the control tree, according the supplied parameters.
-
-
- This method will check for uniqueness of the UniqueNames of the registered docks. If
- there are two docks with equal unique names an exception will be thrown.
-
- A Dictionary, containing UniqueName/DockZoneID pairs.
- A Dictionary, containing UniqueName/Index pairs.
-
-
-
- Docks the dock to a zone with ClientID = newParentClientID.
-
- The dock which should be docked.
- The ClientID of the new parent.
-
-
-
- Cycles through all registered docks and retrieves their parents. The Dictionary
- returned by this method could be passed to SetRegisteredDockParents().
-
-
- A dictionary, containing UniqueName/DockZoneID pairs.
-
-
-
-
- Cycles through all registered docks and retrieves their indices. The Dictionary
- returned by this method could be passed to SetRegisteredDockParents().
-
-
- A dictionary, containing UniqueName/Index pairs.
-
-
-
-
- Cycles through all registered docks and retrieves their state, depending
- on the omitClosedDocks parameter and the value of the Closed property of
- each RadDock control. The List returned by this method could be used to
- recreate the docks when the user visits the page again.
-
-
- A List, containing UniqueName/DockState pairs.
-
-
-
-
- Cycles through all registered docks and retrieves their state. The List
- returned by this method could be used to recreate the docks when the user
- visits the page again.
-
-
- A List, containing UniqueName/DockState pairs.
-
-
-
-
- Raises the LoadDockLayout event
-
- A DockLayoutEventArgs that contains the event data
-
-
-
- Raises the SaveDockLayout event
-
- A DockLayoutEventArgs that contains the event data
-
-
-
- Ensures that the dock has unique UniqueName or ID properties to its
- RadDockLayout. If the UniqueName or the ID are not unique, throws an
- exception.
-
-
- A string, containing the UniqueName property of the dock, or its
- ID if the UniqueName property is not set. Got from the RadDock.GetUniqueName().
-
-
-
-
- Each dock will use this method in its OnInit event to register
- with the RadDockLayout. This is needed in order the layout to
- be able to manage the dock position, set on the client.
-
-
-
-
- Each zone will use this method in its OnInit event to register
- with the RadDockLayout. This is needed in order the layout to
- be able to manage the dock positions, set on the client.
-
-
-
-
- Docks the dock to a zone with ClientID = newParentClientID.
-
- The dock which should be docked.
- The ClientID of the new parent.
-
-
-
- Each dock will use this method in its OnUnload event to unregister
- with the IDockLayout. This is needed in order the layout to
- be able to manage the dock state properly.
-
-
-
-
- Each zone will use this method in its OnUnload event to unregister
- with the IDockLayout.
-
-
-
-
- Each dock will store its position on the client in the DockZoneChanged event.
- In RaisePostDataChangedEvent() RadDockLayout will reorganize the docks according
- this information.
-
-
-
-
- All docks, which are direct or indirect children of the RadDockLayout
-
-
-
-
- All zones, which are direct or indirect children of the RadDockLayout
-
-
-
-
- Returns the names of all embedded skins. Used by Telerik.Web.Examples.
-
-
-
-
- Returns all registered docks with this RadDockLayout control.
-
-
- Returns a read only collection containing all registered docks.
-
-
-
-
- Returns all registered zones with this RadDockLayout control.
-
-
- Returns a read only collection containing all registered zones.
-
-
-
-
- RadDockLayout will raise the LoadDockLayout event in order to retrieve the parents
- which will be automatically applied on the registered docks. The client
- positions will be applied in a later stage of the lifecycle.
-
-
-
-
- RadDockLayout will raise this event to let the developer to save
- the parents of the registered docks in a database or other storage
- medium. These parents can be later supplied to the LoadDockLayout event.
-
-
-
-
- This is the container where we will store the dock positions, set on the client.
-
-
-
-
- This is the container where we will store the dock positions, set on the client.
-
-
-
-
- By default RadDockLayout will store the positions of its inner docks in
- the ViewState. If you want to store the positions in other storage medium
- such as a database, or the Session, set this property to false. Setting this
- property to false will also minimize the ViewState usage.
-
-
-
- Gets or sets the skin name for the child controls' user interface.
- A string containing the skin name for the control user interface. The
- default is string.Empty.
-
-
- If this property is set, RadDockLayout will set the Skin and EnableEmbeddedSkins properties
- of each child RadDock and RadDockZone, unless their Skin property is not explicitly set.
-
-
-
-
-
- For internal use.
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
- If the Skin property is set, RadDockLayout will set the Skin and EnableEmbeddedSkins properties
- of each child RadDock and RadDockZone, unless their Skin property is not explicitly set.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
-
- RadDockZone is a control which represents a virtual placeholder, where
- RadDock controls could be docked.
-
-
-
-
- Returns the unique name for the dock, based on the UniqueName and
- the ID properties.
-
-
- A string, containing the UniqueName property of the dock, or its
- ID, if the UniqueName property is not set.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets a value, indicating whether the control will set the size
- of the docked RadDock controls to 100% depending the control Orientation.
-
-
- When Orientation is Horizontal, the Height of the docked RadDock controls
- will become 100%, otherwise the Width will become 100%.
-
-
-
-
- Gets or sets a css class name, which will be applied when the RadDockZone is highlighted.
- If this property is not set, the control will not have a highlighted style.
-
-
-
-
- Gets or sets the unique name of the control. If this property is not set, the control ID will be
- used instead. RadDockLayout will throw an exception if it finds two RadDockZone controls with
- the same UniqueName.
-
-
-
-
- Gets or sets a value that specifies the dimension in which docked RadDock controls are arranged
-
-
-
-
- Gets or sets the minimum width of the RadDockZone control.
-
-
-
-
- Gets or sets the minimum height of the RadDockZone control.
-
-
-
-
-
-
-
-
- Telerik RadSlider is a flexible UI component that allows users to select a value from a defined range using a smooth or step-based slider.
-
-
-
-
- Adds the property to the IScriptDescriptor, if it's value is different from the given default.
-
- The descriptor to add the property to.
- The property name.
- The current value of the property.
- The default value.
-
-
-
- Gets an XML string representing the state of the control. All child items and their properties are serialized in this
- string.
-
-
- A String representing the state of the control - child items, properties etc.
-
-
- Use the GetXml method to get the XML state of the control. You can cache it and then restore it using
- the LoadXml method.
-
-
-
-
- Loads the control from an XML string.
-
-
- The string representing the XML from which the control will be populated.
-
-
- Use the LoadXml method to populate the control from an XML string. You can use it along the GetXml
- method to implement caching.
-
-
-
-
- Gets or sets the name of the validation group to which this validation
- control belongs.
-
-
- The name of the validation group to which this validation control belongs. The
- default is an empty string (""), which indicates that this property is not set.
-
-
- This property works only when CausesValidation
- is set to true.
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when a tab
- from the tabstrip is clicked.
-
-
- The URL of the Web page to post to from the current page when a tab from the
- tabstrip control is clicked. The default value is an empty string (""), which causes
- the page to post back to itself.
-
-
-
-
- Gets or sets a value indicating whether validation is performed when an item within
- the control is selected.
-
-
- true if validation is performed when an item is selected;
- otherwise, false. The default value is true.
-
-
- By default, page validation is performed when an item is selected. Page
- validation determines whether the input controls associated with a validation
- control on the page all pass the validation rules specified by the validation
- control. You can specify or determine whether validation is performed on both the
- client and the server when an item is clicked by using the CausesValidation
- property. To prevent validation from being performed, set the
- CausesValidation property to false.
-
-
-
-
- Generic method for splitting items in rows.
-
-
- For example:
- GetRowItems(1, 2, [1,2,3,4,5,6,7]) -> [1,2,3,4]
- GetRowItems(2, 2, [1,2,3,4,5,6,7]) -> [5,6,7]
-
- Item type
- Current row index
- Total number of rows
- The full IList of items
- The items belonging to the specified row
-
-
-
- Given that new items are inserted one at a time at the last row
- this method will arrange them in such manner that the
- number of items in the rows is in descending order.
-
-
- Works by moving the first item from each row (starting from the last)
- to the end of the previous in order to leave any incomplete rows at the end.
-
-
- If we have:
- 1) A, B
- 2) C,
- 3) D, E
-
- The result would be:
- 1) A, B
- 2) C, D
- 3) E
-
- Item type
- The array of Queues representing each row
-
-
-
- Generic method for splitting items in columns.
-
-
- For example:
- GetColumnItems(1, 2, [1,2,3,4,5,6,7]) -> [1,3,5,7]
- GetColumnItems(2, 2, [1,2,3,4,5,6,7]) -> [2,4,6]
-
- Item type
- Current column index
- Total number of columns
- The full IList of items
- The items belonging to the specified column
-
-
-
- Gets or sets a value indicating the server-side event handler that is called
- when the value of the slider has been changed.
-
-
- A string specifying the name of the server-side event handler that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnValueChanged
- event handler that is called
- when the value of the slider has been changed. Two parameters are passed to the handler:
-
- sender, the RadSlider object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnValueChanged property.
-
-
-
-
-
-
-
- Adds HTML attributes and styles that need to be rendered to the specified . This method is used primarily by control developers.
-
- A that represents the output stream to render HTML content on the client.
-
-
-
- The Enabled property is reset in AddAttributesToRender in order
- to avoid setting disabled attribute in the control tag (this is
- the default behavior). This property has the real value of the
- Enabled property in that moment.
-
-
-
-
- Get/Set the value of the slider
-
-
-
-
- Get/Set the SelectionStart of the slider
-
-
-
-
- Get/Set the SelectionEnd of the slider
-
-
-
-
- Get/Set the IsSelectionRangeEnabled of the slider
-
-
-
-
- Get/Set the IsDirectionReversed of the slider
-
-
-
-
- Get/Set the LiveDrag of the slider
-
-
-
-
- Get/Set the ItemType of the slider items
-
-
-
-
- Get/Set the TrackPosition of the slider track
-
-
-
-
- Get/Set orientation of the slider
-
-
-
-
- Get/Set the step with which the slider value will change
-
-
-
-
- Get/Set the step with which the slider value will change
-
-
-
-
- Get/Set the delta with which the value will change
- when user click on the track
-
-
-
-
- Get/Set the delta with which the value will change
- when user click on the track
-
-
-
-
- Get/Set the length of the animation
-
-
-
-
- Get/Set the length of the slider including the decrease and increase handles.
-
-
- If the slider is horizontal the width will be set, otherwise the height will be set.
-
-
-
-
- Get/Set the Width of the slider including the decrease and increase handles.
-
-
-
-
- Get/Set the Height of the slider including the decrease and increase handles.
-
-
-
-
- True to cause a postback on value change.
-
-
-
-
- Get/Set the min value of the slider
-
-
-
-
- Get/Set the max value of the slider
-
-
-
-
- Enable/Disable whether the mouse wheel should be handled
-
-
-
-
- Show/Hide the drag handle
-
-
-
-
- Show/Hide the decrease handle
-
-
-
-
- Show/Hide the increase handle
-
-
-
-
- Gets or sets the text for the decrease handle
-
-
-
-
- Gets or sets the text for the increase handle
-
-
-
-
- Gets or sets the text for the increase handle
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadSlider control is initialized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlider object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientLoad property.
-
-
- <script type="text/javascript">
- function OnClientLoad(sender, args)
- {
- var slider = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the sliding is started.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientSlideStart
- client-side event handler is called before
- the sliding is started. Two parameters are passed to the handler:
-
- sender, the RadSlider object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientSlideStart property.
-
-
- <script type="text/javascript">
- function OnSlideBeginHandler(sender, args)
- {
- var slider = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- while the handle is being slided.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientSlide
- client-side event handler that is called
- while the handle is being slided. Two parameters are passed to the handler:
-
- sender, the RadSlider object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientSlide property.
-
-
- <script type="text/javascript">
- function OnSlidingHandler(sender, args)
- {
- var slider = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when slide has ended.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientSlideEnd
- client-side event handler that is called
- when slide has ended. Two parameters are passed to the handler:
-
- sender, the RadSlider object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientSlideEnd property.
-
-
- <script type="text/javascript">
- function OnSlideHandler(sender, args)
- {
- var slider = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when the value of the slider has been changed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlider object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientValueChanged property.
-
-
- <script type="text/javascript">
- function OnClientValueChanged(sender, args)
- {
- var slider = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- just before the value of the slider changes.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlider object.
- args.
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientValueChanging property.
-
-
- <script type="text/javascript">
- function OnClientValueChanging(sender, args)
- {
- var slider = sender;
- }
- </script>
-
-
-
-
-
-
- Gets a RadSliderItemCollection object that contains the items of the current RadSlider control.
-
-
- A RadSliderItemCollection that contains the items of the current RadSlider control. By default
- the collection is empty (RadSlider is a numeric slider).
-
-
- Use the Items property to access the child items of RadSlider
- You can add, remove or modify items from the Items collection.
-
-
-
-
- Gets a RadSliderItem object that represents the selected item in the RadSlider control in case
- ItemType of the control equals SliderItemType.Item.
-
- A RadSliderItem object that represents the selected item. If there are no items in the Items collection
- of the RadSlider control, returns null.
-
-
-
- Gets a collection of RadSliderItem objects that represent the items in the RadSlider control that are currently selected
- in case ItemType of the control equals SliderItemType.Item.
-
- A RadSliderItemCollection containing the selected items.
-
-
-
- Gets the Value of the selected item in case
- ItemType of the RadSlider control equals SliderItemType.Item.
-
-
- The Value of the selected item. If there are no items in the Items collection
- of the RadSlider control, returns empty string.
-
-
-
-
- RadPane class
-
-
-
-
- This property is being used internally by the RadSplitter control.
- Setting it may lead to unpredictable results.
-
-
- The Index property is used internally.
-
-
-
-
- Sets/gets the min width to which the pane can be resized
-
-
-
-
- Sets/gets the max width to which the pane can be resized
-
-
-
-
- Sets/gets the min height to which the pane can be resized
-
-
-
-
- Sets/gets the max height to which the pane can be resized
-
-
-
-
- Sets/gets whether the content of the pane will get a scrollbars when it exceeds the pane area size
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadPane is collapsed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the pane object that raised the event
- args
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientCollapsed property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the RadPane is collapsed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the pane object that raised the event
- args
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientCollapsing property.
-
-
- <script type="text/javascript">
- function OnClientCollapsing(sender, args)
- {
- alert(sender.get_id());
- args.set_cancel(true);//cancel the event
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadPane is expanded.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the pane object that raised the event
- args
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientExpanded property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the RadPane is expanded.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the pane object that raised the event
- args
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientExpanding property.
-
-
- <script type="text/javascript">
- function OnClientExpanding(sender, args)
- {
- alert(sender.get_id());
- args.set_cancel(true);//cancel the event
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when the RadPane is resized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the pane object that raised the event
- args with the following methods:
-
- get_oldWidth - the width of the pane before the resize
- get_oldHeight - the height of the pane before the resize
-
-
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientResized property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the RadPane is resized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the event object
- args with the following methods:
-
- get_delta - the delta with which the pane will be resized
- get_resizeDirection - the direction in which the pane will be resized. You can use the Telerik.Web.UI.SplitterDirection hash to check the direction. The 2 possible values are : Forward and Backward
-
-
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientResizing property.
-
-
- <script type="text/javascript">
- function OnClientResizing(sender, eventArgs)
- {
- alert(sender.get_id());
- eventArgs.set_cancel(true);//cancel the event
- }
- </script>
-
-
-
-
-
-
- Sets/gets whether the scrolls position will be persisted acrosss postbacks
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Get the expanded Size of the pane, when the pane is collapsed.
- In case the Orientation of the splitter is Vertical, returns the expanded Height, otherwise, the expanded Width.
-
-
-
-
- Set the expanded Size of the pane, when the pane is collapsed.
- In case the Orientation of the splitter is Vertical, sets the expanded Height, otherwise, the expanded Width.
-
-
-
-
- Sets/gets whether the pane is collapsed
-
-
-
-
- Sets/gets whether the pane is locked
-
-
-
-
- The URL of the page to load inside the pane.
-
-
- Use the ContentUrl property if you want to load external page
- into the pane content area.
-
-
-
-
- Get/Set the Width of the pane.
-
-
-
-
- Get/Set the Height of the pane.
-
-
-
-
- Reference to the parent Splitter object
-
-
-
-
- RadSlidingPane class
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets/gets the min height to which the pane can be resized
-
-
-
-
- Sets/gets the height of the sliding pane
-
-
-
-
- Sets/gets the min width to which the pane can be resized
-
-
-
-
- Sets/gets the width of the sliding pane
-
-
-
-
- Sets/gets whether the resize bar will be active
-
-
-
-
- Sets/gets whether the sliding pane will automatically dock on open
-
-
-
-
- Gets or sets the path to an image to display for the item.
-
-
-
-
- Sets/gets way the tab of the pane is rendered
-
-
-
-
- Sets/gets whether the pane can be docked
-
-
-
-
- The title that will be displayed when the pane is docked/docked
-
-
-
-
- Gets or sets the text for resize bar
-
-
-
-
- Gets or sets the text for undock image
-
-
-
-
- Gets or sets the text for dock image
-
-
-
-
- Gets or sets the text for collapse image
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadSlidingPane is docked.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlidingPane client object that fired the event
- args
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientDocked property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadSlidingPane is undocked.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlidingPane client object that fired the event
- args
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientUndocked property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the RadSlidingPane is docked.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlidingPane client object that fired the event
- args
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientDocking property.
-
-
- <script type="text/javascript">
- function OnClientDocking(sender, args)
- {
- alert(sender.get_id());
- args.set_cancel(true);//cancel the event
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the RadSlidingPane is undocked.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlidingPane client object that fired the event
- args
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientUndocking property.
-
-
- <script type="text/javascript">
- function OnClientUndocking(sender, args)
- {
- alert(sender.get_id());
- args.set_cancel(true);//cancel the event
- }
- </script>
-
-
-
-
-
-
- Reference to the parent SlidingZone object
-
-
-
-
- RadSlidingZone class
-
-
-
-
- Gets the collection of child items in the RadSplitter
- control.
-
-
- A SplitterItemsCollection that represents the children within
- the RadSplitter control. The default is empty collection.
-
-
- Use this property to retrieve the child items of the RadSplitter
- control. You can also use it to programmatically add or remove items.
-
-
- The following example demonstrates how to programmatically add items.
-
- void Page_Load(object sender, EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- RadPane pane1 = new RadPane();
- RadSplitter1.Items.Add(pane1);
-
- RadSplitbar splitBar1 = new RadSplitBar();
- RadSplitter1.Items.Add(splitBar1);
-
- RadPane pane2 = new RadPane();
- RadSplitter1.Items.Add(pane2);
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- If Not Page.IsPostBack Then
- Dim pane1 As RadPane = New RadPane()
- RadSplitter1.Items.Add(pane1)
-
- Dim splitBar1 As RadSplitbar = New RadSplitBar()
- RadSplitter1.Items.Add(splitBar1)
-
- Dim pane2 As RadPane = New RadPane()
- RadSplitter1.Items.Add(pane2)
-
- End If
- End Sub
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets/gets the height of the sliding zone
-
-
-
-
- Sets/gets the width of the sliding zone
-
-
-
-
- Sets/gets whether the pane should be clicked in order to open
-
-
-
-
- Sets/gets the id of the pane that is will be displayed docked
-
-
-
-
- Sets/gets the id of the pane that is will be expanded
-
-
-
-
- Sets/gets the direction in which the panes will slide
-
-
-
-
- Sets/gets the step in px in which the resize bar will be moved when dragged.
-
-
-
-
- Sets/gets the duration of the slide animation in milliseconds.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadSlidingZone control is initialized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSlidingZone that fired the event
- args
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientLoad property.
-
-
-
-
-
-
-
- Reference to the parent Splitter object
-
-
-
-
- RadSplitBar class
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets/gets the collapse mode of the splitbar
-
-
-
-
- Sets/gets whether the resize bar will be active
-
-
-
-
- Sets/gets the step in px in which the resize bar will be moved when dragged.
-
-
-
-
- Reference to the parent Splitter object
-
-
-
-
- Gets or sets the text for collapse bar images
-
-
-
-
- Specifies the collapse mode of a splitbar
-
-
-
-
- No collapse is available
-
- 1
-
-
-
- Forward collapse availalbe only
-
- 2
-
-
-
- Backward collapse availalbe only
-
- 3
-
-
-
- Both - forward and backward collapse available
-
- 4
-
-
-
- telerik RadSplitter is a flexible UI component for ASP.NET applications which allows users to manage effectively the content size and layout.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets/gets the pixels that should be substracted from the splitter height when its height is defined in percent
-
-
-
-
- Resize the splitter in 100% of the page
-
-
-
-
- Whether the Splitter should be visible during its initialization or not
-
-
-
-
- Sets/gets the height of the splitter
-
-
-
-
- Sets/gets the width of the splitter
-
-
-
-
- Sets/gets whether the rendering of the splitter panes is previewed during the resize
-
-
-
-
- Sets/gets whether the splitter will be resized when the browser window is resized. The Width or Height properties should be defined in percent.
-
-
-
-
- Sets/gets whether the splitter will resize when the parent pane is resized
-
-
-
-
- Specify the orientation of the panes inside the splitter
-
-
-
-
- Set/Get the way the panes are resized
-
-
-
-
- Set/Get size of the splitter border
-
-
-
-
- Set/Get size of the splitter panes border
-
-
-
-
- Set/Get size of the split bars - in pixels
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadSplitter control is initialized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSplitter that fired the event
- args
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientLoad property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadSplitter is resized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientResized
- client-side event handler is called when the RadSplitter
- is resized. Two parameters are passed to the handler:
-
- sender, the event object
- eventArgs with the following methods:
-
- get_oldWidth - the width of the splitter before the resize
- get_oldHeight - the height of the splitter before the resize
-
-
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientResized property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before the RadSplitter is resized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadSplitter that fired the event
- args with the following methods:
-
- get_newWidth - the new width that will be applied to the RadSplitter object
- get_newHeight - the new height that will be applied to the RadSplitter object
-
-
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientResizing property.
-
-
- <script type="text/javascript">
- function OnClientResizing(sender, args)
- {
- alert(sender.get_id());
- args.set_cancel(true);//cancel the event
- }
- </script>
-
-
-
-
-
-
- Specifies the collapse direction options of the splitter bar
-
-
-
-
- On collapse the current pane is collapsed
-
- 1
-
-
-
- On collapse the next pane is resized
-
- 2
-
-
-
- A collection of SplitterItem objects in a
- RadSplitter control.
-
-
- The SplitterItemsCollection class represents a collection of
- SplitterItem objects. The SplitterItem objects in turn represent
- panes items within a RadSplitter control.
-
-
- Use the indexer to programmatically retrieve a
- single SplitterItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of panes in the collection.
-
-
- Use the Add method to add panes in the collection.
-
-
- Use the Remove method to remove panes from the
- collection.
-
-
-
-
-
-
- Initializes a new instance of the SplitterItemsCollection class.
- Use the constructor to create a new SplitterItemsCollection class.
- The container of the collection.
-
-
- Appends a SplitterItem to the end of the collection.
-
- The following example demonstrates how to programmatically add items in a
- RadSplitter control.
-
- RadPane pane = new RadPane();
-
- RadMenu1.Panes.Add(pane);
-
-
- Dim pane As RadPane = New RadPane()
-
- RadMenu1.Panes.Add(pane)
-
-
-
-
-
-
-
-
-
- Inserts the specified SplitterItem in the collection at the specified
- index location.
-
-
- Use the Insert method to add a SplitterItem to the collection at
- the index specified by the index parameter.
-
- The location in the collection to insert the SplitterItem.
- The SplitterItem to add to the collection.
-
-
-
-
-
-
-
- Determines the index value that represents the position of the specified
- SplitterItem in the collection.
-
-
- The zero-based index position of the specified SplitterItem in the
- collection.
-
-
- Use the IndexOf method to determine the index value of the
- SplitterItem specified by the item parameter in the collection. If an item
- with this criteria is not found in the collection, -1 is returned.
-
- A SplitterItem to search for in the collection.
-
-
-
-
-
-
-
- Determines whether the collection contains the specified
- SplitterItem.
-
-
- true if the collection contains the specified item; otherwise,
- false.
-
-
- Use the Contains method to determine whether the SplitterItem
- specified by the item parameter is in the collection.
-
- A SplitterItem to search for in the collection.
-
-
-
-
-
-
- Removes the specified SplitterItem from the collection.
-
- Use the Remove method to remove a SplitterItem from the
- collection.
-
-
- The following example demonstrates how to programmatically remove a SplitterItem from a
- RadSplitter control.
-
- RadPane pane = RadSplitter1.GetPaneById("pane1");
- if (pane != null)
- {
- RadSplitter1.Panes.Remove(pane);
- }
-
-
- Dim pane As RadPane = RadSplitter1.GetPaneById("pane1")
- If Not pane Is Nothing Then
- RadSplitter1.Panes.Remove(pane)
- End If
-
-
-
-
-
-
-
-
- Removes the SplitterItem at the specified index from the collection.
-
- Use the RemoveAt method to remove the SplitterItem at the
- specified index from the collection.
-
- The index of the SplitterItem to remove.
-
-
- Removes all items from the collection.
-
- Use the Clear method to remove all items from the collection. The
- Count property is set to 0.
-
-
-
-
-
- Gets a SplitterItem at the specified index in the collection.
-
-
-
- Use this indexer to get a SplitterItem from the collection at the
- specified index, using array notation.
-
-
- The zero-based index of the SplitterItem to retrieve from the
- collection.
-
-
-
-
- Specifies the scrolling options for the RadPane object
-
-
-
-
- Both X and Y scrolls are displayed
-
- 1
-
-
-
- Only the scroll on X dimension is displayed
-
- 2
-
-
-
- Only the scroll on Y dimension is displayed
-
- 3
-
-
-
- No scrolls are displayed
-
- 1
-
-
-
- Specifies resize mode options for the RadSplitter object
-
-
-
-
- On resize of a pane the adjacent pane is resized also
-
- 1
-
-
-
- On resize of a pane the other panes are resize proportionaly
-
- 2
-
-
-
- On resize of a pane the end pane in the splitter is resized also
-
- 3
-
-
-
- Specifies the available directions for the slide panes
-
-
-
-
- Slide panes are sliding from left to right
-
- 1
-
-
-
- Slide panes are sliding from right to left
-
- 2
-
-
-
- Slide panes are sliding from top to bottom
-
- 3
-
-
-
- Slide panes are sliding from bottom to top
-
- 4
-
-
-
- Specifies views of the pane tab
-
-
-
-
- Pane tab is displayed using its Title and Icon
-
- 1
-
-
-
- Pane tab is displayed using only its Title
-
- 2
-
-
-
- Pane tab is displayed using only its Icon
-
- 3
-
-
-
-
-
-
-
- This class holds a reference to a single updated control and the loading panel to
- display.
-
-
-
-
- A constructor of AjaxUpdatedControl which takes the control to be updated and the
- id of the loading panel to display as parameters.
-
-
-
- The default constructor of the AjaxUpdatedControl class.
-
-
- The ID of the web control that is to be updated.
-
-
-
- The ID of the RadAjaxLoadingPanel to be displayed during the update of the
- control.
-
-
-
-
- Gets or sets the render mode of the the RadAjaxPanel. The default value is Block.
-
-
-
- A collection of the controls that are updated by the AjaxManager.
-
-
- Adds an item to the collection
-
-
- Removes the specified item from the collection
-
-
- Checks wether the collection contains the specified item.
-
-
- Gets the index of the specified item in the collection.
-
-
- Inserts an item at the specified index in the collection.
-
-
- The default indexer of the collection.
-
-
-
- Represents a single AjaxManager setting - a mapping between a control that
- initiates an AJAX request and a collection of controls to be updated by the
- operation.
-
-
-
- Default constructor for the AjaxSetting class.
-
-
-
- A constructor for AjaxSetting taking the ClientID of the control initiating the
- AJAX request.
-
-
-
-
- This field holds the control id of the control that can initiate an
- AJAX request.
-
-
-
- Corresponds to the EventName property of the internally created AsyncPostBackTrigger.
-
-
- A collection of controls that will be updated by the AjaxManager
-
-
-
- Summary description for ConfiguredControls.
-
-
-
- The default constructor for AjaxSettingsCollection class.
-
-
-
- This method adds a new AjaxSetting to the collection by building one from its
- parameters.
-
- The web control to be ajaxified (the initiator of the AJAX request)
- The web control that has to be updated.
-
-
- Adds an item to the collection.
- An instance of AjaxSetting to be added.
-
-
- Removes an item from the collection.
- An instance of AjaxSetting to be removed
-
-
- Checks wether the item is present in the collection.
- An instance of AjaxSetting
-
-
- Determines the index of the specified item.
- An instance of AjaxSetting
-
-
- Inserts an item at the specificed index in the collection.
- The index at which the setting will be inserted
- An instance of AjaxSetting
-
-
- Default indexer for the collection.
-
-
- Redirects the page to another location.
- None.
-
- This method is usually used in the AJAX event handler instead of
- Response.Redirect(). It provides the only way to redirect to a page which does not
- contain any AJAX control at all.
-
-
- The following code redirects from a button's click event handler. Note the control
- should be ajaxified in order redirection to work.
-
- private void Button1_Click(object sender, System.EventArgs e)
- {
- RadAjaxManager1.Redirect("support.aspx");
- }
-
-
- Private Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles Button1.Click
- RadAjaxManager1.Redirect("support.aspx")
- End Sub 'Button1_Click
-
-
-
-
- Displays an alert message at client-side.
- None.
-
- This is the easiest way to show a message, generated from the server, on the
- client in a message box.
- Note: Special characteres are not escaped.
-
-
- The following example illustrates a sample usage of the Alert
- method.
-
- private void Button1_Click(object sender, System.EventArgs e)
- {
- if (!UserAccessAllowed(UserProfile))
- {
- RadAjaxManager1.Alert("You are not allowed to access this user control!");
- }
- else
- {
- LoadSecretControl();
- }
- }
-
-
- Private Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles Button1.Click
- If Not UserAccessAllowed(UserProfile) Then
- RadAjaxManager1.Alert("You are not allowed to access this user control!")
- Else
- LoadSecretControl()
- End If
- End Sub 'Button1_Click
-
-
-
-
-
- Gets client side code which raises an AjaxRequest event in either AJAX Manager or
- AJAX Panel.
-
-
-
-
-
-
-
-
-
-
-
-
- Sets focus to the specified web control after the AJAX Request is
- finished.
-
-
-
-
- Sets focus to the specified web control after the AJAX Request is
- finished.
-
-
-
-
- Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
-
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
-
-
-
-
-
- Enables browser back/forward buttons state (browser history).
- Please, review the RadAjax "Changes and backwards compatibility" - "Back and Forward buttons" article for more info.
-
-
-
-
- By design ASP.NET AJAX Framework cancels the ongoing ajax request if you try to initiate another one prior to receiving the response for the first request.
- By setting the RequestQueueSize property to a value greater than zero, you are enabling the queuing mechanism of RadAjax
- that will allow you to complete the ongoing request and then initiate the pending requests in the control queue.
-
-
- If the queue is full (queue size equals RequestQueueSize), an attempt for new ajax request will be discarded.
-
-
- The default value is 0 (queuing disabled).
-
-
-
-
- This enumeration defines the possible positions of the RadAjaxLoadingPanel background
- image. This property matters only if the Skin property is set. The default value is Center.
-
-
-
-
- Registers the CSS references
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the names of all embedded skins. Used by Telerik.Web.Examples.
-
-
-
-
-
-
-
-
- Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
-
-
-
- If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.
-
-
-
-
-
- Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
-
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
-
-
-
-
-
-
-
-
-
- Gets or sets transparency in percentage. Default value is 0 percents.
-
-
-
-
- Defines whether the transparency set in the skin will be applied.
- Default value is True.
-
-
-
-
- Gets or sets the z-index of the loading panel. Default value is 90,000.
-
-
-
-
- Gets or sets the position of the skin background image. Default value is center.
-
-
-
-
- The IsSticky property of the Loading Panel controls where
- the panel will appear during the AJAX request. If this property is set to
- true, the panel will appear where you have placed it on your
- webform. If this property is set to false, the Loading panel will
- appear on the place of the updated control(s).
- By default this property is set to false.
-
-
-
-
- Gets or sets a value specifying the delay in milliseconds, after which the
- RadAjaxLoadingPanel will be shown. If the request returns before this time,
- the RadAjaxLoadingPanel will not be shown.
-
-
-
-
- Gets or sets a value that specifies the minimum time in milliseconds that the
- RadAjaxLoadingPanel will last. The control will not be updated before this
- period has passed even if the request returns. This will ensure more smoother interface
- for your page.
-
-
-
-
- Gets or sets animation duration in milliseconds. Default value is 0, i.e. no animation.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will not use any skin (backwards compatibility)
- If EnableEmbeddedSkins is set to false, the control will not register a skin CSS file automatically.
-
-
-
-
-
- For internal use.
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
-
- Gets the real skin name for the control user interface. If Skin is not set, returns
- an empty string, otherwise returns Skin.
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This class is required as a base class for any page that hosts a
- RadAjaxManager control and runs under Medium trust privileges.
-
- Inheriting from RadAjaxPage is not required if you run under Full trust.
-
-
-
- This property specifies the layout of the AjaxPanel. When this is set to FALSE,
- the AjaxPanel contents will not be wrapped to a new line no matter how wide the control
- is.
-
-
-
-
- This property specifies the horizontal alignment of the RadAjaxPanel
- contents.
-
-
-
-
- This property specifies the image that should be displayed as background in the
- AjaxPanel. If left blank, no background image is applied.
-
-
-
-
- Summary description for CalendarDayCollection.
-
-
-
-
- IClientData is used to provide a standard way of generating data output from a component,
- which will be processed and streamed thereafter to the client.
-
-
-
-
- gets the data that is required on the client. The returned ArrayList should be processed
- further and serialized as clientside array of values.
-
- ArrayList with the properties to serialize to the client.
-
-
-
- Adds a RadCalendarDay object to the collection of CalendarDays.
-
- The RadCalendarDay object to add to the collection.
-
-
-
- Returns a zero based index of a RadCalendarDay object depending on the passed index.
-
- The zero-based index, RadCalendarDay object or the date represented by the searched RadCalendarDay object.
- A zero based index of the RadCalendarDay object in the collection, or -1 if the RadCalendarDay object is not found.
-
-
-
- Adds a RadCalendarDay object in the collection at the specified index.
-
- The index after which the RadCalendarDay object is inserted.
- The RadCalendarDay object to insert.
-
-
-
- Deletes a RadCalendarDay object from the collection.
-
- The RadCalendarDay object to remove.
-
-
-
- Deletes the RadCalendarDay object from the collection at the specified index.
-
- The index in collection at which the RadCalendarDay object will be deleted.
-
-
-
- Removes all RadCalendarDay objects in the collection of CalendarDays.
-
-
-
-
- Checks whether a specific RadCalendarDay object is in the collection of CalendarDays.
-
- The RadCalendarDay object to search.
- True if the RadCalendarDay is found, false otherwise.
-
-
-
-
- Copies the elements of CalendarDayCollection to a new
- of elements.
-
- A one-dimensional of
- elements containing copies of the elements of the .
- Please refer to for details.
-
-
-
-
-
-
- Returns a RadCalendarDay object depending on the passed index.
- Only integer and string indexes are valid.
-
-
-
-
- Summary description for DayTemplatess.
-
-
-
-
- Summary description for CalendarViewCollection.
-
-
-
-
- Adds a CalendarView object to the collection of CalendarDays.
-
- The CalendarView object to add to the collection.
-
-
-
- Returns a zero based index of a CalendarView object depending on the passed index.
-
- The zero-based index, CalendarView object or the date represented by the searched CalendarView object.
- A zero based index of the CalendarView object in the collection, or -1 if the CalendarView object is not found.
-
-
-
- Adds a CalendarView object in the collection at the specified index.
-
- The index after which the CalendarView object is inserted.
- The CalendarView object to insert.
-
-
-
- Deletes a CalendarView object from the collection.
-
- The CalendarView object to remove.
-
-
-
- Deletes the CalendarView object from the collection at the specified index.
-
- The index in collection at which the CalendarView object will be deleted.
-
-
-
- Removes all CalendarView objects in the collection of CalendarDays.
-
-
-
-
- Checks whether a specific CalendarView object is in the collection of CalendarDays.
-
- The CalendarView object to search.
- True if the CalendarView is found, false otherwise.
-
-
-
- Reverses the order of the elements in the entire collection.
-
-
- Please refer to for details.
-
-
-
- Copies the elements of CalendarViewCollection to a new
- of elements.
-
- A one-dimensional of
- elements containing copies of the elements of the .
- Please refer to for details.
-
-
-
-
- Sorts the elements in the entire
- using the specified interface.
-
-
- The implementation to use when comparing elements.
- -or-
- A null reference to use the implementation
- of each element.
-
- Please refer to for details.
-
-
-
- Sorts the elements in the specified range
- using the specified interface.
-
- The zero-based starting index of the range
- of elements to sort.
- The number of elements to sort.
-
- The implementation to use when comparing elements.
- -or-
- A null reference to use the implementation
- of each element.
-
- and do not denote a
- valid range of elements in the .
-
- is less than zero.
- -or-
- is less than zero.
-
-
- Please refer to for details.
-
-
-
- Returns a CalendarView object depending on the passed index.
- Only integer and string indexes are valid.
-
-
-
-
- Adds a DateTime object to the collection of CalendarDays.
-
- The RadDate object to add to the collection.
-
-
-
- Returns a zero based index of a DateTime object depending on the passed index.
-
- The zero-based index, DateTime object or the date represented by the searched DateTime object.
- A zero based index of the DateTime object in the collection, or -1 if the DateTime object is not found.
-
-
-
- Adds a DateTime object in the collection at the specified index.
-
- The index after which the DateTime object is inserted.
- The DateTime object to insert.
-
-
-
- Deletes a DateTime object from the collection.
-
- The DateTime object to remove.
-
-
-
- Deletes the DateTime object from the collection at the specified index.
-
- The index in collection at which the DateTime object will be deleted.
-
-
-
- Removes all DateTime objects in the collection of CalendarDays.
-
-
-
-
- Checks whether a specific DateTime object is in the collection of CalendarDays.
-
- The DateTime object to search.
- True if the DateTime is found, false otherwise.
-
-
-
- Reverses the order of the elements in the entire collection.
-
-
- Please refer to for details.
-
-
-
- Copies the elements of DateTimeCollection to a new
- of elements.
-
- A one-dimensional of
- elements containing copies of the elements of the .
- Please refer to for details.
-
-
-
- Sorts the elements in the or a portion of it.
-
-
- Sorts the elements in the entire
- using the implementation of each element.
-
-
- Please refer to for details.
-
-
-
- Sorts the elements in the entire
- using the specified interface.
-
-
- The implementation to use when comparing elements.
- -or-
- A null reference to use the implementation
- of each element.
-
- Please refer to for details.
-
-
-
- Sorts the elements in the specified range
- using the specified interface.
-
- The zero-based starting index of the range
- of elements to sort.
- The number of elements to sort.
-
- The implementation to use when comparing elements.
- -or-
- A null reference to use the implementation
- of each element.
-
- and do not denote a
- valid range of elements in the .
-
- is less than zero.
- -or-
- is less than zero.
-
-
- Please refer to for details.
-
-
-
- Returns a DateTime object depending on the passed index.
- Only integer and string indexes are valid.
-
-
-
-
- Summary description for Constants.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- RadCalendar class
-
-
-
-
- Base class based on the PropertyBag implementation, which descends from WebControl class.
-
-
-
-
- Implements the PropertyBag class that is the foundation for building Telerik RadCalendar and
- handles properties values.Used by the ViewState mechanism also.
-
-
-
-
- Create controls from template, fill ContentPanes and add them to Controls collection.
-
-
-
-
- This method supports the Telerik RadCalendar infrastructure and
- is not intended to be used directly from your code.
-
-
-
-
- Recursively searches for a control with the specified id in the passed controls collection.
-
- The id of the control to look for.
- The current Controls collection to search in.
- The found control or null if nothing was found.
-
-
-
- When using templates, their content is instantiated and "lives" inside the
- Controls
- collection of RadCalendar class. To access the controls instantiated from the
- templates they must be found using this method (RadCalendar implements
- INamingContainer interface).
-
- Reference to the found control or null if no control was found.
- The ID of the searched control.
-
-
-
- Restores view-state information from a previous page request that was saved by the SaveViewState method.
-
- The saved view state.
-
-
-
- Saves any server control view-state changes that have occurred since the time the page was posted back to the server.
-
- The saved view state.
-
-
-
- Gets or sets the
- MonthYearFastNavigationSettings
- object whose inner properties can be used to modify the fast Month/Year client
- navigation settings.
-
- MonthYearFastNavigationSettings
-
-
-
- Returns whether RadCalendar is currently in design mode.
-
-
-
- Gets or sets default path for the grid images when EnableEmbeddedSkins is set to false.
- A string containing the path for the grid images. The default is string.Empty.
-
-
-
-
-
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server
- control on the client.
-
-
- The CSS class rendered by the Web server control on the client. The default is
- calendarWrapper_[skin name].
-
-
-
-
- Gets or sets a collection of type
-
- CalendarDayTemplateCollection which stores the created templates to use with
- RadCalendar. All of the
- items are represented by
- DayTemplate
- instances.
-
-
-
-
- Gets the instance of
-
- CalendarClientEvents class which defines the JavaScript functions (client-side
- event handlers) that are invoked when specific client-side events are raised.
-
-
-
-
- Gets or sets whether the repeatable days logic should be supported on the client
- (effective for client calendar - with set property
- AutoPostBack="false").
-
-
- true, if the repeatable days logic should be supported on the
- client; otherwise, false. The default value is
- true.
-
-
- The EnableRepeatableDaysOnClient property has effect over the
- logic of the recurring events to the calendar. It should be true, if you wants the
- repeatable days to be supported by a calendar with AutoPostBack="false". If you are not
- using repeatable days or/and client calendar, you can improve the calendar performance
- by setting it to false.
-
- SpecialDays Property
-
-
-
- Gets or sets the format string that will be applied to the dates presented in the
- calendar area.
-
-
- For additional details see Date Format Pattern
- topic
-
-
-
-
- Gets or sets the the count of rows to be displayed by a single
- CalendarView.
-
-
- If the calendar represents a multi view, this property applies to the child views
- inside the multi view.
-
-
-
-
- Gets or sets the the count of columns to be displayed by a single
- CalendarView.
-
-
- If the calendar represents a multi view, this property applies to the child views
- inside the multi view.
-
-
-
-
- Gets or sets the Width applied to a single
- CalendarView.
-
-
- If the calendar represents a multi view, this property applies to the child views
- inside the multi view.
-
-
-
-
- Gets or sets the Height applied to a single
- CalendarView.
-
-
- If the calendar represents a multi view, this property applies to the child views
- inside the multi view.
-
-
-
-
- Gets or sets the predefined pairs of rows and columns, so that the product of
- the two values is exactly 42, which guarantees valid calendar layout. It is applied
- on a single view level to every
- MonthView
- instance in the calendar.
-
-
- The following values are applicable and defined in the MonthLayout
- enumeration:
-
- Layout_7columns_x_6rows - horizontal layout
-
- Layout_14columns_x_3rows - horizontal layout
-
- Layout_21columns_x_2rows - horizontal layout
-
- Layout_7rows_x_6columns - vertical layout, required when
- UseDaysAsSelectors
- is true and
- Orientation
- is set to
-
- RenderInColumns.
-
- Layout_14rows_x_3columns - vertical layout, required when
- UseDaysAsSelectors
- is true and
- Orientation
- is set to
-
- RenderInColumns.
-
- Layout_21rows_x_2columns - vertical layout, required when
- UseDaysAsSelectors
- is true and
- Orientation
- is set to
-
- RenderInColumns.
-
-
-
-
- Gets or sets the horizontal alignment of the date cells content inside the
- calendar area.
- The HorizontalAlign enumeration is defined in
- System.Web.UI.WebControls
-
-
-
-
-
- Member name
-
-
- Description
-
-
-
-
- Center
-
- The contents of a container are centered.
-
-
- Justify
- The contents of a container are uniformly spread out and
- aligned with both the left and right margins.
-
-
- Left
- The contents of a container are left justified.
-
-
- NotSet
- The horizontal alignment is not set.
-
-
- Right
- The contents of a container are right justified.
-
-
-
-
-
-
- Gets or sets the vertical alignment of the date cells content inside the
- calendar area.
- The VerticalAlign enumeration is defined in
- System.Web.UI.WebControls
-
-
-
-
- Member name
- Description
-
-
- Bottom
- Text or object is aligned with the bottom of the enclosing
- control.
-
-
- Middle
- Text or object is aligned with the center of the enclosing
- control.
-
-
- NotSet
- Vertical alignment is not set.
-
-
- Top
- Text or object is aligned with the top of the enclosing
- control.
-
-
-
-
-
-
- Gets or sets the the count of rows to be displayed by a multi month
- CalendarView.
-
-
-
-
- Gets or sets the the count of columns to be displayed by a multi month
- CalendarView.
-
-
-
-
- Gets or sets the maximum date valid for selection by
- Telerik RadCalendar. Must be interpreted as the Higher bound of the valid
- dates range available for selection. Telerik RadCalendar will not allow
- navigation or selection past this date.
-
-
- This property has a default value of 12/30/2099
- (Gregorian calendar date).
-
-
-
-
- Gets or sets the minimal date valid for selection by
- Telerik RadCalendar. Must be interpreted as the Lower bound of the valid
- dates range available for selection. Telerik RadCalendar will not allow
- navigation or selection prior to this date.
-
-
- This property has a default value of 1/1/1980
- (Gregorian calendar date).
-
-
-
-
- Specifies the day to display as the first day of the week on the
- RadCalendar
- control.
- The FirstDayOfWeek enumeration can be found in
- System.Web.UI.WebControls Namespace.
-
-
- The FirstDayOfWeek enumeration represents the values that specify
- which day to display as the first day of the week on the
- RadCalendar
- control.
-
-
- Member name
- Description
-
-
- Default
- The first day of the week is specified by the system
- settings.
-
-
- Friday
- The first day of the week is Friday.
-
-
- Monday
- The first day of the week is Monday.
-
-
- Saturday
- The first day of the week is Saturday.
-
-
- Sunday
- The first day of the week is Sunday.
-
-
- Thursday
- The first day of the week is Thursday.
-
-
- Tuesday
- The first day of the week is Tuesday.
-
-
- Wednesday
- The first day of the week is Wednesday.
-
-
-
-
-
-
- Sets or returns the currently selected date. The default value is the value of
- System.DateTime.MinValue.
-
-
- Use the SelectedDate property to determine the selected date on the
- RadCalendar
- control.
- The SelectedDate property and the
- SelectedDates
- collection are closely related. When the
- EnableMultiSelect
- property is set to false, a mode that allows only a single date selection,
- SelectedDate and SelectedDates[0] have the same value and
- SelectedDates.Count equals 1. When the EnableMultiSelect property is
- set to true, mode that allows multiple date selections, SelectedDate
- and SelectedDates[0] have the same value.
- The SelectedDate property is set using a System.DateTime
- object.
- When the user selects a date on the RadCalendar control, the
- SelectionChanged
- event is raised. The SelectedDate property is updated to the selected date.
- The SelectedDates collection is also updated to contain just this
- date.
-
- Note Both the SelectedDate property and the
- SelectedDates collection are updated before the SelectionChanged
- event is raised. You can override the date selection by using the
- OnSelectionChanged event handler to manually set the
- SelectedDate property. The SelectionChanged event does not get
- raised when this property is programmatically set.
-
-
-
-
-
- Gets or sets the value that is used by
- RadCalendar to determine
- the viewable area displayed .
-
-
- By default, the FocusedDate property returns the current
- system date when in runtime, and in design mode defaults to
- System.DateTime.MinValue. When the FocusedDate is
- set, from that point, the value returned by the FocusedDate
- property is the one the user sets.
-
-
-
-
- Gets or sets the row index where the
- FocusedDate
- (and the month view it belongs to) will be positioned inside a multi view area.
-
-
-
-
- Gets or sets the column index where the
- FocusedDate
- (and the month view it belongs to) will be positioned inside a multi view area.
-
-
-
-
- Gets a collection of
- RadDate objects (that
- encapsulate values of type System.DateTime) that represent the
- selected dates on the RadCalendar control.
-
-
- A
-
- DateTimeCollection that contains a collection of
- RadDate objects (that
- encapsulate values of type System.DateTime) representing the selected
- dates on the RadCalendar control. The default value is an empty
- DateTimeCollection.
-
-
- Use the SelectedDates collection to determine the currently selected
- dates on the
- RadCalendar
- control.
- The
- SelectedDate
- property and the SelectedDates collection are closely related. When the
- EnableMultiSelect
- property is set to false, a mode that allows only a single date selection,
- SelectedDate and SelectedDates[0] have the same value and
- SelectedDates.Count equals 1. When the
- EnableMultiSelect
- property is set to true, mode that allows multiple date selections,
- SelectedDate and SelectedDates[0] have the same value.
- The SelectedDates property stores a collection of
- RadDate objects (that
- encapsulate values of type System.DateTime).
- When the user selects a date or date range (for example with the column or
- rows selectors) on the RadCalendar control, the
- SelectionChanged
- event is raised. The selected dates are added to the SelectedDates
- collection, accumulating with previously selected dates. The range of dates are not
- sorted by default. The SelectedDate property is also updated to
- contain the first date in the SelectedDates collection.
- You can also use the SelectedDates collection to programmatically
- select dates on the Calendar control. Use the
-
- Add,
-
- Remove,
-
- Clear, and
-
- SelectRange methods to programmatically manipulate the selected dates in the
- SelectedDates collection.
-
- Note Both the SelectedDate property and the
- SelectedDates collection are updated before the SelectionChanged
- event is raised.You can override the dates selection by using the
- OnSelectionChanged event handler to manually set the
- SelectedDates collection. The SelectionChanged event is not
- raised when this collection is programmatically set.
-
-
-
-
-
- Gets or sets an integer value representing the number of
- CalendarView
- views that will be scrolled when the user clicks on a fast navigation link.
-
-
-
-
- Specifies the display formats for the days of the week used as selectors by
- RadCalendar.
-
-
- Use the DayNameFormat property to specify the name format for the days
- of the week. This property is set with one of the DayNameFormat
- enumeration values. You can specify whether the days of the week are displayed as
- the full name, short (abbreviated) name, first letter of the day, or first two
- letters of the day.
- The DayNameFormat enumeration represents the display formats for the
- days of the week used as selectors by RadCalendar.
-
-
- Member name
- Description
-
-
- FirstLetter
- The days of the week displayed with just the first letter. For
- example, T.
-
-
- FirstTwoLetters
- The days of the week displayed with just the first two
- letters. For example, Tu.
-
-
- Full
- The days of the week displayed in full format. For example,
- Tuesday.
-
-
- Short
- The days of the week displayed in abbreviated format. For
- example, Tues.
-
-
-
-
-
-
- Gets or sets a DateTimeFormatInfo instance that defines the
- culturally appropriate format of displaying dates and times as specified by the default
- culture.
-
-
- A DateTimeFormatInfo can be created only for the invariant
- culture or for specific cultures, not for neutral cultures.
- The cultures are generally grouped into three sets: the invariant culture,
- the neutral cultures, and the specific cultures.
- The invariant culture is culture-insensitive. You can specify the invariant
- culture by name using an empty string ("") or by its culture identifier 0x007F.
- InvariantCulture retrieves an instance of the invariant culture.
- It is associated with the English language but not with any country/region. It can
- be used in almost any method in the Globalization namespace that requires a
- culture. If a security decision depends on a string comparison or a case-change
- operation, use the InvariantCulture to ensure that the behavior will be
- consistent regardless of the culture settings of the system. However, the invariant
- culture must be used only by processes that require culture-independent results,
- such as system services; otherwise, it produces results that might be
- linguistically incorrect or culturally inappropriate.
- A neutral culture is a culture that is associated with a language but not
- with a country/region. A specific culture is a culture that is associated with a
- language and a country/region. For example, "fr" is a neutral culture and "fr-FR"
- is a specific culture. Note that "zh-CHS" (Simplified Chinese) and "zh-CHT"
- (Traditional Chinese) are neutral cultures.
- The user might choose to override some of the values associated with the
- current culture of Windows through Regional and Language Options (or Regional
- Options or Regional Settings) in Control Panel. For example, the user might choose
- to display the date in a different format or to use a currency other than the
- default for the culture.
- If UseUserOverride is true and the specified culture
- matches the current culture of Windows, the CultureInfo uses those
- overrides, including user settings for the properties of the
- DateTimeFormatInfo instance returned by the DateTimeFormat property,
- the properties of the NumberFormatInfo instance returned by the
- NumberFormat property, and the properties of the
- CompareInfo instance returned by the CompareInfo
- property. If the user settings are incompatible with the culture associated with
- the CultureInfo (for example, if the selected calendar is not one of the
- OptionalCalendars ), the results of the methods and the values of
- the properties are undefined.
-
- Note: In this version of RadCalendar the
- NumberFormatInfo instance returned by the
- NumberFormat property is not taken into account.
-
-
-
-
- Gets or sets the CultureInfo instance that represents
- information about the culture of this RadCalendar object.
- A CultureInfo class describes information about the culture of this
- RadCalendar instance including the names of the culture, the writing system, and
- the calendar used, as well as access to culture-specific objects that provide
- methods for common operations, such as formatting dates and sorting strings.
-
-
- The culture names follow the RFC 1766 standard in the format
- "<languagecode2>-<country/regioncode2>", where <languagecode2> is
- a lowercase two-letter code derived from ISO 639-1 and <country/regioncode2>
- is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is
- "en-US". In cases where a two-letter language code is not available, the
- three-letter code derived from ISO 639-2 is used; for example, the three-letter
- code "div" is used for cultures that use the Dhivehi language. Some culture names
- have suffixes that specify the script; for example, "-Cyrl" specifies the Cyrillic
- script, "-Latn" specifies the Latin script.
- The following predefined CultureInfo names and identifiers are
- accepted and used by this class and other classes in the System.Globalization
- namespace.
-
-
-
-
Culture Name
-
Culture Identifier
-
Language-Country/Region
-
-
-
"" (empty string)
-
0x007F
-
invariant culture
-
-
-
af
-
0x0036
-
Afrikaans
-
-
-
af-ZA
-
0x0436
-
Afrikaans - South Africa
-
-
-
sq
-
0x001C
-
Albanian
-
-
-
sq-AL
-
0x041C
-
Albanian - Albania
-
-
-
ar
-
0x0001
-
Arabic
-
-
-
ar-DZ
-
0x1401
-
Arabic - Algeria
-
-
-
ar-BH
-
0x3C01
-
Arabic - Bahrain
-
-
-
ar-EG
-
0x0C01
-
Arabic - Egypt
-
-
-
ar-IQ
-
0x0801
-
Arabic - Iraq
-
-
-
ar-JO
-
0x2C01
-
Arabic - Jordan
-
-
-
ar-KW
-
0x3401
-
Arabic - Kuwait
-
-
-
ar-LB
-
0x3001
-
Arabic - Lebanon
-
-
-
ar-LY
-
0x1001
-
Arabic - Libya
-
-
-
ar-MA
-
0x1801
-
Arabic - Morocco
-
-
-
ar-OM
-
0x2001
-
Arabic - Oman
-
-
-
ar-QA
-
0x4001
-
Arabic - Qatar
-
-
-
ar-SA
-
0x0401
-
Arabic - Saudi Arabia
-
-
-
ar-SY
-
0x2801
-
Arabic - Syria
-
-
-
ar-TN
-
0x1C01
-
Arabic - Tunisia
-
-
-
ar-AE
-
0x3801
-
Arabic - United Arab Emirates
-
-
-
ar-YE
-
0x2401
-
Arabic - Yemen
-
-
-
hy
-
0x002B
-
Armenian
-
-
-
hy-AM
-
0x042B
-
Armenian - Armenia
-
-
-
az
-
0x002C
-
Azeri
-
-
-
az-AZ-Cyrl
-
0x082C
-
Azeri (Cyrillic) - Azerbaijan
-
-
-
az-AZ-Latn
-
0x042C
-
Azeri (Latin) - Azerbaijan
-
-
-
eu
-
0x002D
-
Basque
-
-
-
eu-ES
-
0x042D
-
Basque - Basque
-
-
-
be
-
0x0023
-
Belarusian
-
-
-
be-BY
-
0x0423
-
Belarusian - Belarus
-
-
-
bg
-
0x0002
-
Bulgarian
-
-
-
bg-BG
-
0x0402
-
Bulgarian - Bulgaria
-
-
-
ca
-
0x0003
-
Catalan
-
-
-
ca-ES
-
0x0403
-
Catalan - Catalan
-
-
-
zh-HK
-
0x0C04
-
Chinese - Hong Kong SAR
-
-
-
zh-MO
-
0x1404
-
Chinese - Macau SAR
-
-
-
zh-CN
-
0x0804
-
Chinese - China
-
-
-
zh-CHS
-
0x0004
-
Chinese (Simplified)
-
-
-
zh-SG
-
0x1004
-
Chinese - Singapore
-
-
-
zh-TW
-
0x0404
-
Chinese - Taiwan
-
-
-
zh-CHT
-
0x7C04
-
Chinese (Traditional)
-
-
-
hr
-
0x001A
-
Croatian
-
-
-
hr-HR
-
0x041A
-
Croatian - Croatia
-
-
-
cs
-
0x0005
-
Czech
-
-
-
cs-CZ
-
0x0405
-
Czech - Czech Republic
-
-
-
da
-
0x0006
-
Danish
-
-
-
da-DK
-
0x0406
-
Danish - Denmark
-
-
-
div
-
0x0065
-
Dhivehi
-
-
-
div-MV
-
0x0465
-
Dhivehi - Maldives
-
-
-
nl
-
0x0013
-
Dutch
-
-
-
nl-BE
-
0x0813
-
Dutch - Belgium
-
-
-
nl-NL
-
0x0413
-
Dutch - The Netherlands
-
-
-
en
-
0x0009
-
English
-
-
-
en-AU
-
0x0C09
-
English - Australia
-
-
-
en-BZ
-
0x2809
-
English - Belize
-
-
-
en-CA
-
0x1009
-
English - Canada
-
-
-
en-CB
-
0x2409
-
English - Caribbean
-
-
-
en-IE
-
0x1809
-
English - Ireland
-
-
-
en-JM
-
0x2009
-
English - Jamaica
-
-
-
en-NZ
-
0x1409
-
English - New Zealand
-
-
-
en-PH
-
0x3409
-
English - Philippines
-
-
-
en-ZA
-
0x1C09
-
English - South Africa
-
-
-
en-TT
-
0x2C09
-
English - Trinidad and Tobago
-
-
-
en-GB
-
0x0809
-
English - United Kingdom
-
-
-
en-US
-
0x0409
-
English - United States
-
-
-
en-ZW
-
0x3009
-
English - Zimbabwe
-
-
-
et
-
0x0025
-
Estonian
-
-
-
et-EE
-
0x0425
-
Estonian - Estonia
-
-
-
fo
-
0x0038
-
Faroese
-
-
-
fo-FO
-
0x0438
-
Faroese - Faroe Islands
-
-
-
fa
-
0x0029
-
Farsi
-
-
-
fa-IR
-
0x0429
-
Farsi - Iran
-
-
-
fi
-
0x000B
-
Finnish
-
-
-
fi-FI
-
0x040B
-
Finnish - Finland
-
-
-
fr
-
0x000C
-
French
-
-
-
fr-BE
-
0x080C
-
French - Belgium
-
-
-
fr-CA
-
0x0C0C
-
French - Canada
-
-
-
fr-FR
-
0x040C
-
French - France
-
-
-
fr-LU
-
0x140C
-
French - Luxembourg
-
-
-
fr-MC
-
0x180C
-
French - Monaco
-
-
-
fr-CH
-
0x100C
-
French - Switzerland
-
-
-
gl
-
0x0056
-
Galician
-
-
-
gl-ES
-
0x0456
-
Galician - Galician
-
-
-
ka
-
0x0037
-
Georgian
-
-
-
ka-GE
-
0x0437
-
Georgian - Georgia
-
-
-
de
-
0x0007
-
German
-
-
-
de-AT
-
0x0C07
-
German - Austria
-
-
-
de-DE
-
0x0407
-
German - Germany
-
-
-
de-LI
-
0x1407
-
German - Liechtenstein
-
-
-
de-LU
-
0x1007
-
German - Luxembourg
-
-
-
de-CH
-
0x0807
-
German - Switzerland
-
-
-
el
-
0x0008
-
Greek
-
-
-
el-GR
-
0x0408
-
Greek - Greece
-
-
-
gu
-
0x0047
-
Gujarati
-
-
-
gu-IN
-
0x0447
-
Gujarati - India
-
-
-
he
-
0x000D
-
Hebrew
-
-
-
he-IL
-
0x040D
-
Hebrew - Israel
-
-
-
hi
-
0x0039
-
Hindi
-
-
-
hi-IN
-
0x0439
-
Hindi - India
-
-
-
hu
-
0x000E
-
Hungarian
-
-
-
hu-HU
-
0x040E
-
Hungarian - Hungary
-
-
-
is
-
0x000F
-
Icelandic
-
-
-
is-IS
-
0x040F
-
Icelandic - Iceland
-
-
-
id
-
0x0021
-
Indonesian
-
-
-
id-ID
-
0x0421
-
Indonesian - Indonesia
-
-
-
it
-
0x0010
-
Italian
-
-
-
it-IT
-
0x0410
-
Italian - Italy
-
-
-
it-CH
-
0x0810
-
Italian - Switzerland
-
-
-
ja
-
0x0011
-
Japanese
-
-
-
ja-JP
-
0x0411
-
Japanese - Japan
-
-
-
kn
-
0x004B
-
Kannada
-
-
-
kn-IN
-
0x044B
-
Kannada - India
-
-
-
kk
-
0x003F
-
Kazakh
-
-
-
kk-KZ
-
0x043F
-
Kazakh - Kazakhstan
-
-
-
kok
-
0x0057
-
Konkani
-
-
-
kok-IN
-
0x0457
-
Konkani - India
-
-
-
ko
-
0x0012
-
Korean
-
-
-
ko-KR
-
0x0412
-
Korean - Korea
-
-
-
ky
-
0x0040
-
Kyrgyz
-
-
-
ky-KZ
-
0x0440
-
Kyrgyz - Kazakhstan
-
-
-
lv
-
0x0026
-
Latvian
-
-
-
lv-LV
-
0x0426
-
Latvian - Latvia
-
-
-
lt
-
0x0027
-
Lithuanian
-
-
-
lt-LT
-
0x0427
-
Lithuanian - Lithuania
-
-
-
mk
-
0x002F
-
Macedonian
-
-
-
mk-MK
-
0x042F
-
Macedonian - FYROM
-
-
-
ms
-
0x003E
-
Malay
-
-
-
ms-BN
-
0x083E
-
Malay - Brunei
-
-
-
ms-MY
-
0x043E
-
Malay - Malaysia
-
-
-
mr
-
0x004E
-
Marathi
-
-
-
mr-IN
-
0x044E
-
Marathi - India
-
-
-
mn
-
0x0050
-
Mongolian
-
-
-
mn-MN
-
0x0450
-
Mongolian - Mongolia
-
-
-
no
-
0x0014
-
Norwegian
-
-
-
nb-NO
-
0x0414
-
Norwegian (Bokmål) - Norway
-
-
-
nn-NO
-
0x0814
-
Norwegian (Nynorsk) - Norway
-
-
-
pl
-
0x0015
-
Polish
-
-
-
pl-PL
-
0x0415
-
Polish - Poland
-
-
-
pt
-
0x0016
-
Portuguese
-
-
-
pt-BR
-
0x0416
-
Portuguese - Brazil
-
-
-
pt-PT
-
0x0816
-
Portuguese - Portugal
-
-
-
pa
-
0x0046
-
Punjabi
-
-
-
pa-IN
-
0x0446
-
Punjabi - India
-
-
-
ro
-
0x0018
-
Romanian
-
-
-
ro-RO
-
0x0418
-
Romanian - Romania
-
-
-
ru
-
0x0019
-
Russian
-
-
-
ru-RU
-
0x0419
-
Russian - Russia
-
-
-
sa
-
0x004F
-
Sanskrit
-
-
-
sa-IN
-
0x044F
-
Sanskrit - India
-
-
-
sr-SP-Cyrl
-
0x0C1A
-
Serbian (Cyrillic) - Serbia
-
-
-
sr-SP-Latn
-
0x081A
-
Serbian (Latin) - Serbia
-
-
-
sk
-
0x001B
-
Slovak
-
-
-
sk-SK
-
0x041B
-
Slovak - Slovakia
-
-
-
sl
-
0x0024
-
Slovenian
-
-
-
sl-SI
-
0x0424
-
Slovenian - Slovenia
-
-
-
es
-
0x000A
-
Spanish
-
-
-
es-AR
-
0x2C0A
-
Spanish - Argentina
-
-
-
es-BO
-
0x400A
-
Spanish - Bolivia
-
-
-
es-CL
-
0x340A
-
Spanish - Chile
-
-
-
es-CO
-
0x240A
-
Spanish - Colombia
-
-
-
es-CR
-
0x140A
-
Spanish - Costa Rica
-
-
-
es-DO
-
0x1C0A
-
Spanish - Dominican Republic
-
-
-
es-EC
-
0x300A
-
Spanish - Ecuador
-
-
-
es-SV
-
0x440A
-
Spanish - El Salvador
-
-
-
es-GT
-
0x100A
-
Spanish - Guatemala
-
-
-
es-HN
-
0x480A
-
Spanish - Honduras
-
-
-
es-MX
-
0x080A
-
Spanish - Mexico
-
-
-
es-NI
-
0x4C0A
-
Spanish - Nicaragua
-
-
-
es-PA
-
0x180A
-
Spanish - Panama
-
-
-
es-PY
-
0x3C0A
-
Spanish - Paraguay
-
-
-
es-PE
-
0x280A
-
Spanish - Peru
-
-
-
es-PR
-
0x500A
-
Spanish - Puerto Rico
-
-
-
es-ES
-
0x0C0A
-
Spanish - Spain
-
-
-
es-UY
-
0x380A
-
Spanish - Uruguay
-
-
-
es-VE
-
0x200A
-
Spanish - Venezuela
-
-
-
sw
-
0x0041
-
Swahili
-
-
-
sw-KE
-
0x0441
-
Swahili - Kenya
-
-
-
sv
-
0x001D
-
Swedish
-
-
-
sv-FI
-
0x081D
-
Swedish - Finland
-
-
-
sv-SE
-
0x041D
-
Swedish - Sweden
-
-
-
syr
-
0x005A
-
Syriac
-
-
-
syr-SY
-
0x045A
-
Syriac - Syria
-
-
-
ta
-
0x0049
-
Tamil
-
-
-
ta-IN
-
0x0449
-
Tamil - India
-
-
-
tt
-
0x0044
-
Tatar
-
-
-
tt-RU
-
0x0444
-
Tatar - Russia
-
-
-
te
-
0x004A
-
Telugu
-
-
-
te-IN
-
0x044A
-
Telugu - India
-
-
-
th
-
0x001E
-
Thai
-
-
-
th-TH
-
0x041E
-
Thai - Thailand
-
-
-
tr
-
0x001F
-
Turkish
-
-
-
tr-TR
-
0x041F
-
Turkish - Turkey
-
-
-
uk
-
0x0022
-
Ukrainian
-
-
-
uk-UA
-
0x0422
-
Ukrainian - Ukraine
-
-
-
ur
-
0x0020
-
Urdu
-
-
-
ur-PK
-
0x0420
-
Urdu - Pakistan
-
-
-
uz
-
0x0043
-
Uzbek
-
-
-
uz-UZ-Cyrl
-
0x0843
-
Uzbek (Cyrillic) - Uzbekistan
-
-
-
uz-UZ-Latn
-
0x0443
-
Uzbek (Latin) - Uzbekistan
-
-
-
vi
-
0x002A
-
Vietnamese
-
-
-
vi-VN
-
0x042A
-
Vietnamese - Vietnam
-
-
-
-
-
-
-
- Gets the default System.Globalization.Calendar instance as
- specified by the default culture.
-
-
- A calendar divides time into measures, such as weeks, months, and years. The
- number, length, and start of the divisions vary in each calendar.
- Any moment in time can be represented as a set of numeric values using a
- particular calendar. For example, the last vernal equinox occurred at (0.0, 0, 46,
- 8, 20, 3, 1999) in the Gregorian calendar. An implementation of Calendar can
- map any DateTime value to a similar set of numeric values, and
- DateTime can map such sets of numeric values to a textual representation
- using information from Calendar and DateTimeFormatInfo. The
- textual representation can be culture-sensitive (for example, "8:46 AM March 20th
- 1999 AD" for the en-US culture) or culture-insensitive (for example,
- "1999-03-20T08:46:00" in ISO 8601 format).
- A Calendar implementation can define one or more eras. The
- Calendar class identifies the eras as enumerated integers where the current
- era (CurrentEra) has the value 0.
- In order to make up for the difference between the calendar year and the
- actual time that the earth rotates around the sun or the actual time that the moon
- rotates around the earth, a leap year has a different number of days than a
- standard calendar year. Each Calendar implementation defines leap years
- differently.
- For consistency, the first unit in each interval (for example, the first
- month) is assigned the value 1.
- The System.Globalization namespace includes the following
- Calendar implementations: GregorianCalendar,
- HebrewCalendar, HijriCalendar,
- JapaneseCalendar, JulianCalendar,
- KoreanCalendar, TaiwanCalendar, and
- ThaiBuddhistCalendar.
-
-
-
-
- Gets or sets the default type used by RadCalendar to handle its
- layout, and how will react to user interaction.
-
-
-
-
- Member
- Description
-
-
- Interactive
- Interactive - user is allowed to select dates, navigate,
- etc.
-
-
- Preview
- Preview - does not allow user interaction, for presentation
- purposes only.
-
-
-
-
-
-
- Gets or sets the orientation (rendering direction) of the calendar component.
- Default value is RenderInRows.
-
-
-
-
- Member
- Description
-
-
- RenderInRows
- Renders the calendar data row after row.
-
-
- RenderInColumns
- RenderInColumns - Renders the calendar data column after
- column.
-
-
- None
- Enforces fallback to the default Orientation for
- Telerik RadCalendar.
-
-
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.
-
-
- Setting this property to true will make Telerik RadCalendar postback to the server
- on date selection or when navigating to a different month.
-
-
- The default value is false.
-
-
-
-
- Gets or sets a value indicating whether a tooltips for day cells should be rendered.
-
-
- Setting this property to false will force Telerik RadCalendar to not render day cell tooltips
-
-
- The default value is true.
-
-
-
-
- Gets or sets a value for navigation controls summary.
-
-
- Setting this property to empty string will force Telerik RadCalendar to not render summary attribute
-
-
- The default value is "title and navigation".
-
-
-
-
- Gets or sets a value for RadCalendar summary.
-
-
- Setting this property to empty string will force Telerik RadCalendar to not render summary attribute
-
-
- The default value is "Calendar".
-
-
-
-
- Gets or sets the System.Web.UI.ITemplate that defines how the
- header section of the RadCalendar control is displayed.
-
-
- Header section of the RadCalendar control is displayed under
- the title section and above the main calendar area (the section that displays the
- dates information).
- Use this property to create a template that controls how the header section
- of a RadCalendar control is displayed.
-
- CAUTION This control can be used to display user input, which
- might include malicious client script. Check any information that is sent from
- a client for executable script, SQL statements, or other code before displaying
- it in your application. ASP.NET provides an input request validation feature to
- block script and HTML in user input. Validation server controls are also
- provided to assess user input. For more information, see Validation
- Server Controls in MSDN.
-
-
- The default value is a null reference (Nothing in Visual Basic).
-
-
- The default value is a null reference (Nothing in Visual Basic).
-
- Gets or sets the System.Web.UI.ITemplate that defines how the
- footer section of the RadCalendar control is displayed.
-
-
- Footer section of the RadCalendar control is displayed under
- the main calendar area (the section that displays the dates information).
- Use this property to create a template that controls how the footer section
- of a RadCalendar control is displayed.
-
- CAUTION This control can be used to display user input, which
- might include malicious client script. Check any information that is sent from
- a client for executable script, SQL statements, or other code before displaying
- it in your application. ASP.NET provides an input request validation feature to
- block script and HTML in user input. Validation server controls are also
- provided to assess user input. For more information, see Validation
- Server Controls in MSDN.
-
-
-
-
-
- Gets or sets whether the navigation controls in the title section will be
- displayed.
-
-
-
-
- Gets or sets whether the month/year fast navigation controls in the title section will be
- enabled.
-
-
-
-
- Gets or sets the text displayed for the previous month navigation control. Will be
- applied only if there is no image set (see
- NavigationPrevImage).
-
-
- Use the NavigationPrevText property to provide custom text for the
- previous month navigation element in the title section of
- RadCalendar.
- Note that the NavigationPrevImage has priority and
- its value should be set to an empty string in order to be applied the
- NavigationPrevText value.
-
-
-
-
-
- This property does not automatically encode to HTML. You need
- to convert special characters to the appropriate HTML value, unless
- you want the characters to be treated as HTML. For example, to
- explicitly display the greater than symbol (>), you must use the
- value >.
-
-
-
-
- Because this property does not automatically encode to HTML, it is possible
- to specify an HTML tag for the NavigationPrevText property. For example,
- if you want to display an image for the next month navigation control, you can set
- this property to an expression that contains an <img>
- element. However note that
- NavigationPrevImage
- property is available for this type of functionality.
- This property applies only if the EnableNavigation property
- is set to true.
-
-
- The text displayed for the CalendarView previous month
- navigation cell. The default value is "<".
-
-
-
-
- Gets or sets the text displayed for the next month navigation control. Will be
- applied if there is no image set (see
- NavigationNextImage).
-
-
- The text displayed for the CalendarView next month navigation
- cell. The default value is ">".
-
-
- Use the NavigationNextText property to provide custom text for the
- next month navigation element in the title section of
- RadCalendar.
- Note that the NavigationNextImage has priority and
- its value should be set to an empty string in order to be applied the
- NavigationNextText value.
-
-
-
-
-
- This property does not automatically encode to HTML. You need
- to convert special characters to the appropriate HTML value, unless
- you want the characters to be treated as HTML. For example, to
- explicitly display the greater than symbol (>), you must use the
- value >.
-
-
-
-
- Because this property does not automatically encode to HTML, it is possible
- to specify an HTML tag for the NavigationNextText property. For example,
- if you want to display an image for the next month navigation control, you can set
- this property to an expression that contains an <img>
- element. However note that
- NavigationNextImage
- property is available for this type of functionality.
- This property applies only if the EnableNavigation property
- is set to true.
-
-
-
-
- Gets or sets the text displayed for the fast navigation previous month control.
- Will be applied if there is no image set (see
- FastNavigationPrevImage).
-
-
- The text displayed for the CalendarView selection element in the
- fast navigation previous month cell. The default value is
- "<<".
-
-
- Use the FastNavigationPrevText property to provide custom text for
- the next month navigation element in the title section of
- RadCalendar.
- Note that the FastNavigationPrevImage has priority
- and its value should be set to an empty string in order to be applied the
- FastNavigationPrevText value.
-
-
-
-
-
- This property does not automatically encode to HTML. You need
- to convert special characters to the appropriate HTML value, unless
- you want the characters to be treated as HTML. For example, to
- explicitly display the greater than symbol (>), you must use the
- value >.
-
-
-
-
- Because this property does not automatically encode to HTML, it is possible
- to specify an HTML tag for the FastNavigationPrevText property. For
- example, if you want to display an image for the next month navigation control, you
- can set this property to an expression that contains an
- <img> element. However note that
- FastNavigationPrevImage
- property is available for this type of functionality.
- This property applies only if the EnableNavigation property
- is set to true.
-
-
-
-
- Gets or sets the text displayed for the fast navigation next month control. Will be
- applied if there is no image set (see
- FastNavigationNextImage).
-
-
- The text displayed for the CalendarView selection element in the
- fast navigation next month cell. The default value is ">>".
-
-
- Use the FastNavigationNextText property to provide custom text for
- the next month navigation element in the title section of
- RadCalendar.
- Note that the FastNavigationNextImage has priority
- and its value should be set to an empty string in order to be applied the
- FastNavigationNextText value.
-
-
-
-
-
- This property does not automatically encode to HTML. You need
- to convert special characters to the appropriate HTML value, unless
- you want the characters to be treated as HTML. For example, to
- explicitly display the greater than symbol (>), you must use the
- value >.
-
-
-
-
- Because this property does not automatically encode to HTML, it is possible
- to specify an HTML tag for the FastNavigationNextText property. For
- example, if you want to display an image for the next month navigation control, you
- can set this property to an expression that contains an
- <img> element. However note that
- FastNavigationNextImage
- property is available for this type of functionality.
- This property applies only if the EnableNavigation property
- is set to true.
-
-
-
-
- Gets or sets name of the image that is displayed for the previous month navigation control.
-
-
- When using this property, the whole image URL is generated using also the
- ImagesBaseDir
- (if no skin is applied) or the
- SkinPath
- (if skin is applied) properties values.
-
- Example when skin is NOT defined:
- ImagesBaseDir = "Img/"
- RowSelectorImage = "nav.gif"
- complete image URL : "Img/nav.gif"
- Example when skin is defined:
- SkinPath = "RadControls/Calendar/Skins/"
- RowSelectorImage = "nav.gif"
- complete image URL : "RadControls/Calendar/Skins/nav.gif"
-
-
-
-
- Gets or sets the name of the image that is displayed for the next month navigation control.
-
-
- When using this property, the whole image URL is generated using also the
- ImagesBaseDir
- (if no skin is applied) or the
- SkinPath
- (if skin is applied) properties values.
-
- Example when skin is NOT defined:
- ImagesBaseDir = "Img/"
- RowSelectorImage = "nav.gif"
- complete image URL : "Img/nav.gif"
- Example when skin is defined:
- SkinPath = "RadControls/Calendar/Skins/"
- RowSelectorImage = "nav.gif"
- complete image URL : "RadControls/Calendar/Skins/nav.gif"
-
-
-
-
- Gets or sets the name of the image that is displayed for the previous month fast
- navigation control.
-
-
- When using this property, the whole image URL is generated using also the
- ImagesBaseDir
- (if no skin is applied) or the
- SkinPath
- (if skin is applied) properties values.
-
- Example when skin is NOT defined:
- ImagesBaseDir = "Img/"
- RowSelectorImage = "nav.gif"
- complete image URL : "Img/nav.gif"
- Example when skin is defined:
- SkinPath = "RadControls/Calendar/Skins/"
- RowSelectorImage = "nav.gif"
- complete image URL : "RadControls/Calendar/Skins/nav.gif"
-
-
-
-
- Gets or sets the name of the image that is displayed for the next month fast
- navigation control.
-
-
- When using this property, the whole image URL is generated using also the
- ImagesBaseDir
- (if no skin is applied) or the
- SkinPath
- (if skin is applied) properties values.
-
- Example when skin is NOT defined:
- ImagesBaseDir = "Img/"
- RowSelectorImage = "nav.gif"
- complete image URL : "Img/nav.gif"
- Example when skin is defined:
- SkinPath = "RadControls/Calendar/Skins/"
- RowSelectorImage = "nav.gif"
- complete image URL : "RadControls/Calendar/Skins/nav.gif"
-
-
-
-
- Gets or sets the text displayed as a tooltip for the previous month navigation control.
-
-
- Use the NavigationPrevToolTip property to provide custom text for the
- tooltip of the previous month navigation element in the title section of
- RadCalendar.
-
-
- The tooltip text displayed for the CalendarView previous month
- navigation cell. The default value is "<".
-
-
-
-
- Gets or sets the text displayed as a tooltip for the next month navigation control.
-
-
- The tooltip text displayed for the CalendarView next month
- navigation cell. The default value is ">".
-
-
- Use the NavigationNextToolTip property to provide custom text for the
- tooltip of the next month navigation element in the title section of
- RadCalendar.
-
-
-
-
- Gets or sets the text displayed as a tooltip for the fast navigation previous
- month control.
-
-
- Use the FastNavigationPrevToolTip property to provide custom text for
- the tooltip of the fast navigation previous month element in the title section of
- RadCalendar.
-
-
- The tooltip text displayed for the CalendarView fast navigation
- previous month cell. The default value is "<<".
-
-
-
-
- Gets or sets the text displayed as a tooltip for the fast navigation next month
- control.
-
-
- Use the FastNavigationNextToolTip property to provide custom text for
- the tooltip of the fast navigation next month element in the title section of
- RadCalendar.
-
-
- The tooltip text displayed for the CalendarView fast navigation
- next month cell. The default value is ">>".
-
-
-
-
- Gets or sets the cell spacing that is applied to the title table.
-
-
-
-
- Gets or sets the cell padding that is applied to the title table.
-
-
-
-
- Gets or sets the horizontal alignment of the calendar title.
- The HorizontalAlign enumeration is defined in
- System.Web.UI.WebControls
-
-
-
-
-
- Member name
-
-
- Description
-
-
-
-
- Center
-
- The contents of a container are centered.
-
-
- Justify
- The contents of a container are uniformly spread out and
- aligned with both the left and right margins.
-
-
- Left
- The contents of a container are left justified.
-
-
- NotSet
- The horizontal alignment is not set.
-
-
- Right
- The contents of a container are right justified.
-
-
-
-
-
- Gets or sets the format string that is applied to the calendar title.
-
- The property should contain either a format specifier character or a
- custom format pattern. For more information, see the summary page for
- System.Globalization.DateTimeFormatInfo.
- By default this property uses formatting string of
- 'MMMM yyyy'. Valid formats are all supported by the .NET
- Framework.
- Example:
-
-
"d" is the standard short date pattern.
-
"%d" returns the day of the month; "%d" is a custom pattern.
-
"d " returns the day of the month followed by a white-space character; "d "
- is a custom pattern.
-
-
-
-
- Gets or sets the format string that is applied to the days cells tooltip.
-
- The property should contain either a format specifier character or a
- custom format pattern. For more information, see the summary page for
- System.Globalization.DateTimeFormatInfo.
- By default this property uses formatting string of
- 'dddd, MMMM dd, yyyy'. Valid formats are all supported by the .NET
- Framework.
- Example:
-
-
"d" is the standard short date pattern.
-
"%d" returns the day of the month; "%d" is a custom pattern.
-
"d " returns the day of the month followed by a white-space character; "d "
- is a custom pattern.
-
-
-
-
-
- Gets or sets the separator string that will be put between start and end months in a multi view title.
-
-
-
-
- Gets or sets the name of the file containing the CSS definition used by RadCalendar. Use "~/" (tilde) as a substitution of the web-application root directory.
-
-
-
-
- Gets or sets the cell padding of the table where are rendered the calendar days.
-
-
-
-
- Gets or sets the cell spacing of the table where are rendered the calendar days.
-
-
-
-
- A collection of special days in the calendar to which may be applied specific formatting.
-
- SpecialDays online example
-
-
-
- Gets the style properties for the days in the displayed month.
-
-
- A TableItemStyle that contains the style properties for the days in the displayed month.
-
-
-
-
- Gets the style properties for the weekend dates on the Calendar control.
-
-
- A TableItemStyle that contains the style properties for the weekend dates on the Calendar.
-
-
-
-
- Gets the style properties for the Calendar table container.
-
-
- A TableItemStyle that contains the style properties for the Calendar table container.
-
-
-
-
- Gets the style properties for the days on the Calendar control that are not in the displayed month.
-
-
- A TableItemStyle that contains the style properties for the days on the Calendar control that are not in the displayed month.
-
-
-
-
- Gets the style properties for the days on the Calendar control that are out of the valid range for selection.
-
-
- A TableItemStyle that contains the style properties for the days on the Calendar control that are out of the valid range for selection.
-
-
-
-
- Gets the style properties for the disabled dates.
-
-
- A TableItemStyle that contains the style properties for the disabled dates.
-
-
-
-
- Gets the style properties for the selected dates.
-
-
- A TableItemStyle that contains the style properties for the selected dates.
-
-
-
-
- Gets the style properties applied when hovering over the Calendar days.
-
-
- A TableItemStyle that contains the style properties applied when hovering over the Calendar days.
-
-
-
-
- Gets the style properties of the title heading for the Calendar control.
-
-
- A TableItemStyle that contains the style properties of the title heading for the Calendar.
-
-
-
-
- Gets the style properties for the row and column headers.
-
-
- A TableItemStyle that contains the style properties for the row and column headers.
-
-
-
- Gets the style properties for the Month/Year fast navigation.
-
- A TableItemStyle that contains the style properties for the the Month/Year fast
- navigation.
-
-
-
-
- Gets the style properties for the view selector cell.
-
-
- A TableItemStyle that contains the style properties for the view selector cell.
-
-
-
-
- Exposes the top instance of CalendarView or its derived
- types.
- Every CalendarView class handles the real calculation and
- rendering of RadCalendar's calendric information. The
- CalendarView has the
-
- ChildViews collection which contains all the sub views in case of multi view
- setup.
-
-
-
- Gets or sets whether the column headers will appear on the calendar.
-
-
- Gets or sets whether the row headers will appear on the calendar.
-
-
-
- Gets or sets whether a selector for the entire CalendarView (
- MonthView ) will appear on the calendar.
-
-
-
-
- Gets or sets whether the month matrix, when rendered will show days from other (previous or next)
- months or will render only blank cells.
-
-
-
-
- When the
- ShowColumnHeaders
- and/or
- ShowRowHeaders
- properties are set to true, the UseColumnHeadersAsSelectors property specifies
- whether to use the days of the week, which overrides the used text/image header if
- any.
-
-
-
-
- When the
- ShowColumnHeaders
- and/or
- ShowRowHeaders
- properties are set to true, the UseRowHeadersAsSelectors property
- specifies whether to use the number of the week, which overrides the used text/image
- selector if any.
-
-
-
-
- Use the RowHeaderText property to provide custom text for
- the CalendarView complete row header element.
-
-
-
-
-
- This property does not automatically encode to HTML. You need
- to convert special characters to the appropriate HTML value, unless
- you want the characters to be treated as HTML. For example, to
- explicitly display the greater than symbol (>), you must use the
- value >.
-
-
-
-
- Because this property does not automatically encode to HTML, it is possible
- to specify an HTML tag for the RowHeaderText property. For
- example, if you want to display an image for the next month navigation control, you
- can set this property to an expression that contains an
- <img> element.
- This property applies only if the ShowRowsHeaders
- property is set to true.
-
-
- The text displayed for the CalendarView header element. The default value is "".
-
-
- Gets or sets the text displayed for the row header element.
-
-
-
-
- The image displayed for the CalendarView row header element. The default value is "".
-
-
- Gets or sets the image displayed for the row header element.
-
-
- This property applies only if the ShowRowHeaders property is
- set to true. If RowHeaderText is set too, its
- value is set as an alternative text to the image of the row header.
- When using this property, the whole image URL is generated using also the
- ImagesBaseDir
- value.
- Example:
- ShowRowHeaders = "true"
- ImagesBaseDir = "Img/"
- RowHeaderImage = "selector.gif"
- complete image URL : "Img/selector.gif"
-
-
-
-
- Use the ColumnHeaderText property to provide custom text
- for the CalendarView complete column header element.
-
-
-
-
-
- This property does not automatically encode to HTML. You need
- to convert special characters to the appropriate HTML value, unless
- you want the characters to be treated as HTML. For example, to
- explicitly display the greater than symbol (>), you must use the
- value >.
-
-
-
-
- Because this property does not automatically encode to HTML, it is possible
- to specify an HTML tag for the ColumnHeaderText property. For
- example, if you want to display an image for the next month navigation control, you
- can set this property to an expression that contains an
- <img> element.
- This property applies only if the ShowColumnHeaders
- property is set to true.
-
-
- The text displayed for the CalendarView column header element. The default value is "".
-
-
- Gets or sets the text displayed for the column header element.
-
-
-
-
- The image displayed for the CalendarView column header element in the
- header cells. The default value is "".
-
-
- Gets or sets the image displayed for the column header element.
-
-
- This property applies only if the ShowColumnHeaders property
- is set to true. If ColumnHeaderText is set too,
- its value is set as an alternative text to the image of the column header.
- When using this property, the whole image URL is generated using also the
- ImagesBaseDir
- value.
- Example:
- ShowColumnHeaders="true"
- ImagesBaseDir = "Img/"
- ColumnHeaderImage = "selector.gif"
- complete image URL : "Img/selector.gif"
-
-
-
-
- Gets or sets the text displayed for the complete
- CalendarView
- selection element in the view selector cell.
-
-
- The text displayed for the CalendarView selection element in the
- selector cell. The default value is "".
-
-
- Use the ViewSelectorText property to provide custom text for
- the CalendarView complete selection element in the selector
- cell.
-
-
-
-
-
- This property does not automatically encode to HTML. You need
- to convert special characters to the appropriate HTML value, unless
- you want the characters to be treated as HTML. For example, to
- explicitly display the greater than symbol (>), you must use the
- value >.
-
-
-
-
- Because this property does not automatically encode to HTML, it is possible
- to specify an HTML tag for the ViewSelectorText property. For
- example, if you want to display an image for the next month navigation control, you
- can set this property to an expression that contains an
- <img> element.
- This property applies only if the EnableViewSelector
- property is set to true.
-
-
-
-
- Gets or sets the image displayed for the complete
- CalendarView
- selection element in the view selector cell.
-
-
- The image displayed for the CalendarView selection element in
- the selector cell. The default value is "".
-
-
- When using this property, the whole image URL is generated using also the
- ImagesBaseDir
- value.
- Example:
- ImagesBaseDir = "Img/"
- ViewSelectorImage = "selector.gif"
- complete image URL : "Img/selector.gif"
-
-
-
-
- Allows the selection of multiple dates. If not set, only a single date is selected, and if any dates
- are all ready selected, they are cleared.
-
-
-
-
- Enables the animation shown when the calendar navigates to a different view.
-
-
-
-
- Gets or sets the name of the skin used. All skins reside in the location set by
- the SkinsPath
- Property.
-
-
- For additional information please refer to the
- Visual Settings topic in this manual.
-
-
-
-
- DayRender event is fired after the generation of every calendar cell
- object and just before it gets rendered to the client. It is the last place where
- changes to the already constructed calendar cells can be made.
-
-
-
-
- HeadeCellRender event is fired after the generation of every calendar header cell
- object and just before it gets rendered to the client. It is the preferred place where
- changes to the constructed calendar header cells can be made.
-
-
-
-
- SelectionChanged event is fired when a new date is added or removed from
- the
- SelectedDates
- collection.
-
-
-
-
- DefaultViewChanged event is fired a a navigation to a different date
- range occurred. Generally this is done by using the normal navigation buttons or the
- fast date navigation popup that allows "jumping" to a specified date.
-
-
-
-
- A control which ensures the date entered by the user is verified and
- accurate.
-
-
- The following example demonstrates how to dynamically add
- RadDateInput to the page.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDateInput dateInput = new RadDateInput();
- dateInput.ID = "dateInput";
- dateInput.Format = "d"; //Short date format
- dateInput.Culture = new CultureInfo("en-US");
- dateInput.SelectedDate = DateTime.Now;
-
- DateInputPlaceholder.Controls.Add(dateInput);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim dateInput As New RadDateInput()
- dateInput.ID = "dateInput"
- dateInput.Format = "d" 'Short Date Format
- dateInput.Culture = New CultureInfo("en-US")
- dateInput.SelectedDate = DateTime.Now
-
- DateInputPlaceholder.Controls.Add(dateInput)
- End Sub
-
-
-
- You need to set the DateFormat Property to specify the
- relevant format for the date. You can also specify the culture information by
- setting the Culture Property.
-
-
-
-
- RadInputControl class
-
-
-
- Sets input focus to a RadInput.
-
- Use the Focus method to set the initial focus of the Web page to the
- RadInput. The page will be opened in the browser with the control
- selected.
- The Focus method causes a call to the page focus script to be emitted on the
- rendered page. If the page does not contain a control with an HTML ID attribute
- that matches the control that the Focus method was invoked on, then page focus will
- not be set. An example where this can occur is when you set the focus on a user
- control instead of setting the focus on a child control of the user control. In
- this scenario, you can use the FindControl method to find the child control of the
- user control and invoke its Focus method.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Occurs after all child controls of the RadDateInput control have been created.
- You can customize the control there, and add additional child controls.
-
-
-
-
- Gets or sets the text of the
-
-
- A string used as a label for the control. The default value is empty string
- ("").
-
-
- If the value of this property has not been set, a tag will not be rendered. Keep
- in mind that accessibility standards require labels for all input controls.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
- The following code example demonstrates how to use the Label property:
-
-
-
-
-
- Gets or sets the CSS class applied to the tag rendered along with RadInput
- control.
-
-
- A string used specifying the CSS class of the label of the control. The default
- value is empty string ("").
-
- This property is applicable only if the Label property has been set.
-
-
-
- Gets or sets a value indicating whether an automatic post back to the server
- occurs whenever the user presses the ENTER or the TAB key while in the RadInput
- control.
-
-
- Use the AutoPostBack property to specify whether an automatic post back to the
- server will occur whenever the user presses the ENTER or the TAB key while in the
- RadInput control.
-
-
- true if an automatic postback occurs whenever the user presses the ENTER or the
- TAB key while in the RadInput control; otherwise, false. The default is
- false.
-
-
- The following code example demonstrates how to use the AutoPostBack property
- to automatically display the sum of the values entered in the RadTextBoxes when the
- user presses the ENTER or the TAB key.
- [C#]
-
- </%@ Page Language="C#" AutoEventWireup="True" /%> </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <title>RadTextBox Example </title>
- <script runat="server">
- protected void Page_Load(Object sender, EventArgs e) { int Answer;
- // Due to a timing issue with when page validation occurs, call the
- // Validate method to ensure that the values on the page are valid. Page.Validate();
- // Add the values in the text boxes if the page is valid. if(Page.IsValid) { Answer = Convert.ToInt32(Value1.Text) + Convert.ToInt32(Value2.Text);
- AnswerMessage.Text = Answer.ToString(); }
- } </script>
- </head> <body> <form id="form1" runat="server"> <h3> RadTextBox Example
- </h3> <table> <tr> <td colspan="5"> Enter integer values into the text boxes.
- <br /> The two values are automatically added <br /> when you tab out of the text boxes.
- <br /> </td> </tr> <tr> <td colspan="5">
- </td> </tr> <tr align="center"> <td>
- <radI:RadTextBox ID="Value1" Columns="2" MaxLength="3" AutoPostBack="True" Text="1" runat="server" /> </td> <td>
- + </td> <td> <radI:RadTextBox ID="Value2" Columns="2" MaxLength="3" AutoPostBack="True" Text="1" runat="server" />
- </td> <td> = </td> <td> <asp:Label ID="AnswerMessage" runat="server" />
- </td> </tr> <tr> <td colspan="2">
- <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Value1" ErrorMessage="Please enter a value.<br />" EnableClientScript="False" Display="Dynamic"
- runat="server" /> <asp:RangeValidator ID="Value1RangeValidator" ControlToValidate="Value1" Type="Integer"
- MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />"
- EnableClientScript="False" Display="Dynamic" runat="server" /> </td>
- <td colspan="2"> <asp:RequiredFieldValidator ID="Value2RequiredValidator" ControlToValidate="Value2"
- ErrorMessage="Please enter a value.<br />" EnableClientScript="False" Display="Dynamic" runat="server" />
- <asp:RangeValidator ID="Value2RangeValidator" ControlToValidate="Value2" Type="Integer" MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />"
- EnableClientScript="False" Display="Dynamic" runat="server" /> </td> <td>   </td> </tr> </table>
- </form> </body> </html>
-
<!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <title>RadTextBox Example </title>
<script runat="server">
- Protected Sub Page_Load(sender As Object, e As EventArgs)
Dim Answer As Integer
' Due to a timing issue with when page validation occurs, call the ' Validate method to ensure that the values on the page are valid.
- Page.Validate()
' Add the values in the text boxes if the page is valid. If Page.IsValid Then
</head> <body> <form id="form1" runat="server"> <h3>
- RadTextBox Example </h3> <table> <tr>
- <td colspan="5"> Enter Integer values into the text boxes.
- <br /> The two values are automatically added
- <br /> When you tab out of the text boxes.
- <br /> </td> </tr>
- <tr> <td colspan="5">
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Gets or sets a value indicating whether validation is performed when the
- RadInput control is set to validate when a postback occurs.
-
-
- true if validation is performed when the RadInput control is set to validate
- when a postback occurs; otherwise, false. The default value is false.
-
-
- Use the CausesValidation property to determine whether validation is
- performed on both the client and the server when a RadInput control is set to
- validate when a postback occurs. Page validation determines whether the input
- controls associated with a validation control on the page all pass the validation
- rules specified by the validation control.
- By default, a RadInput control does not cause page validation when the
- control loses focus. To set the RadInput control to validate when a postback
- occurs, set the CausesValidation property to true and the AutoPostBack property to
- true.
- When the value of the CausesValidation property is set to true, you can also
- use the ValidationGroup property to specify the name of the validation group for
- which the RadInput control causes validation.
- This property cannot be set by themes or style sheet themes.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0
-
-
-
- Gets or sets the maximum number of characters allowed in the text box.
-
- The maximum number of characters allowed in the text box. The default is 0, which
- indicates that the property is not set.
-
-
- Use the MaxLength property to limit the number of characters that can be entered
- in the RadInput control. This property cannot be set by themes or style sheet
- themes. For more information, see ThemeableAttribute and Introduction to ASP.NET
- Themes.
-
-
- The following code example demonstrates how to use the MaxLength property to
- limit the number of characters allowed in the RadTextBox control to 3. This example
- has a RadTextBox that accepts user input, which is a potential security threat. By
- default, ASP.NET Web pages validate that user input does not include script or HTML
- elements.
- [C#]
-
- </%@ Page Language="C#" AutoEventWireup="True" /%>
- </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head>
- <title>RadTextBox Example </title>
- <script runat="server">
- protected void AddButton_Click(Object sender, EventArgs e) {
- int Answer;
- Answer = Convert.ToInt32(Value1.Text) + Convert.ToInt32(Value2.Text);
- AnswerMessage.Text = Answer.ToString();
- }
- </script>
- </head> <body> <form id="form1" runat="server">
- <h3> RadTextBox Example </h3> <table>
- <tr> <td colspan="5"> Enter integer values into the text boxes.
- <br /> Click the Add button to add the two values.
- <br /> Click the Reset button to reset the text boxes.
- </td> </tr> <tr> <td colspan="5">
-
- </td> </tr> <tr align="center">
- <td>
- <radI:RadTextBox ID="Value1" Columns="2" MaxLength="3" Text="1" runat="server" />
- </td> <td> + </td>
- <td> <radI:RadTextBox ID="Value2" Columns="2" MaxLength="3" Text="1" runat="server" />
- </td> <td> = </td>
- <td> <asp:Label ID="AnswerMessage" runat="server" /> </td>
- </tr> <tr> <td colspan="2">
- <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Value1"
- ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" />
- <asp:RangeValidator ID="Value1RangeValidator" ControlToValidate="Value1" Type="Integer"
- MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />"
- Display="Dynamic" runat="server" /> </td> <td colspan="2">
- <asp:RequiredFieldValidator ID="Value2RequiredValidator" ControlToValidate="Value2"
- ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" />
- <asp:RangeValidator ID="Value2RangeValidator" ControlToValidate="Value2" Type="Integer"
- MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />"
- Display="Dynamic" runat="server" /> </td> <td>
-   </td> </tr> <tr align="center">
- <td colspan="4"> <asp:Button ID="AddButton" Text="Add" OnClick="AddButton_Click" runat="server" />
- </td> <td>
- </td> </tr> </table> </form> </body> </html>
-
</head> <body> <form id="form1" runat="server">
- <h3> RadTextBox Example </h3> <table> <tr>
- <td colspan="5"> Enter Integer values into the text boxes.
- <br /> Click the Add button To add the two values.
- <br /> Click the Reset button To reset the text boxes.
- </td> </tr> <tr> <td colspan="5">
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Gets or sets a value indicating whether the contents of the RadInput control
- can be changed.
-
-
- true if the contents of the RadInput control cannot be changed; otherwise,
- false. The default value is false.
-
-
- Use the ReadOnly property to specify whether the contents of the RadInput
- control can be changed. Setting this property to true will prevent users from entering
- a value or changing the existing value. Note that the user of the RadInput control
- cannot change this property; only the developer can. The Text value of a RadInput
- control with the ReadOnly property set to true is sent to the server when a postback
- occurs, but the server does no processing for a read-only RadInput. This prevents a
- malicious user from changing a Text value that is read-only. The value of the Text
- property is preserved in the view state between postbacks unless modified by
- server-side code. This property cannot be set by themes or style sheet themes.
-
-
- The following code example demonstrates how to use the ReadOnly property to
- prevent any changes to the text displayed in the RadTextBox control. This example
- has a RadTextBox that accepts user input, which is a potential security threat. By
- default, ASP.NET Web pages validate that user input does not include script or HTML
- elements.
- [C#]
-
- </%@ Page Language="VB" AutoEventWireup="True" /%>
- </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head>
- <title>MultiLine RadTextBox Example </title>
- <script runat="server">
- Protected Sub SubmitButton_Click(sender As Object, e As EventArgs )
- Message.Text = "Thank you for your comment: <br />" + Comment.Text
- End Sub
- Protected Sub Check_Change(sender As Object, e As EventArgs )
- Comment.Wrap = WrapCheckBox.Checked Comment.ReadOnly = ReadOnlyCheckBox.Checked
- End Sub
- </script>
- </head> <body> <form id="form1" runat="server"> <h3>
- MultiLine RadTextBox Example </h3> Please enter a comment and click the submit button.
- <br /> <br />
- <radI:RadTextBox ID="Comment" TextMode="MultiLine" Columns="50" Rows="5" runat="server" />
- <br /> <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Comment"
- ErrorMessage="Please enter a comment.<br />" Display="Dynamic" runat="server" />
- <asp:CheckBox ID="WrapCheckBox" Text="Wrap Text" Checked="True" AutoPostBack="True"
- OnCheckedChanged="Check_Change" runat="server" />
- <asp:CheckBox ID="ReadOnlyCheckBox" Text="ReadOnly" Checked="False" AutoPostBack="True"
- OnCheckedChanged="Check_Change" runat="server" />
- <asp:Button ID="SubmitButton" Text="Submit" OnClick="SubmitButton_Click" runat="server" />
- <hr /> <asp:Label ID="Message" runat="server" /> </form> </body>
- </html>
-
-
-
- This example has a text box that accepts user input, which is a potential
- security threat. By default, ASP.NET Web pages validate that user input does not
- include script or HTML elements.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets or sets a value message shown when the control is empty.
-
- A string specifying the empty message. The default value is empty string.
- ("").
-
-
- Shown when the control is empty and loses focus. You can set the empty message
- text through EmptyMessage property.
-
-
- The following code example demonstrates how to set an empty message in code
- behind:
- [C#]
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets or sets the selection on focus options for the RadInput control
-
- A Telerik.WebControls.SelectionOnFocus object that represents the selection on
- focus in RadInput control. The default value is "None".
-
- None
- CaretToBeginning
- CaretToEnd
- SelectAll
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
- Use this property to provide selection on focus of RadInput control. You
- can set one of the following values:
-
-
- The following example demonstrates how to set the SelectionOnFocus property
- from DropDownList:
-
-
-
-
-
- The InvalidStyleDuration property is used to determine how long (in milliseconds)
- the control will display its invalid style when incorrect data is entered.
-
-
-
-
- Gets or sets an instance of the Telerik.WebControls.InputClientEvents class which defines
- the JavaScript functions (client-side event handlers) that are invoked when specific client-side events are raised.
-
-
-
-
- Gets or sets a value indicating whether the button is displayed in the
- RadInput control.
-
-
- true if the button is displayed; otherwise, false. The default value is true,
- however this property is only examined when the ButtonTemplate property is not a null
- reference (Nothing in Visual Basic).
-
-
- Use the ShowButton property to specify whether the button is displayed in the
- RadInput control.
- The contents of the button are controlled by the ButtonTemplate
- property.
-
-
- The following code example demonstrates how to use the ShowButton property to
- display the button in the RadInput control.
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Gets or sets a value that indicates whether the button should be positioned left or right of the RadInput box.
-
-
-
- Gets or sets the text content of the RadInput control.
-
- The text displayed in the RadInput control. The default is an empty string
- ("").
-
-
- Use the Text property to specify or determine the text displayed in the
- RadInput control. To limit the number of characters accepted by the control, set
- the MaxLength property. If you want to prevent the text from being modified, set
- the ReadOnly property.
- The value of this property, when set, can be saved automatically to a
- resource file by using a designer tool.
-
-
- The following code example demonstrates how to use the Text property to
- specify the text displayed in the RadTextBox control.
- [C#]
-
- </%@ Page Language="C#" AutoEventWireup="True" /%>
- </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head>
- <title>RadTextBox Example </title>
- <script runat="server">
-
- protected void AddButton_Click(object sender, EventArgs e) {
- int Answer;
- Answer = Convert.ToInt32(Value1.Text) + Convert.ToInt32(Value2.Text);
- AnswerMessage.Text = Answer.ToString(); } </script>
- </head> <body> <form id="form1" runat="server"> <h3>
- RadTextBox Example </h3> <table> <tr>
- <td colspan="5"> Enter integer values into the text boxes.
- <br /> Click the Add button to add the two values.
- <br /> Click the Reset button to reset the text boxes.
- </td> </tr> <tr> <td colspan="5">
- </td> </tr> <tr align="center">
- <td> <radI:RadTextBox ID="Value1" Columns="2" MaxLength="3" Text="1" runat="server" />
- </td> <td> + </td>
- <td> <radI:RadTextBox ID="Value2" Columns="2" MaxLength="3" Text="1" runat="server" />
- </td> <td> = </td>
- <td> <asp:Label ID="AnswerMessage" runat="server" />
- </td> </tr> <tr> <td colspan="2">
- <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Value1"
- ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" />
- <asp:RangeValidator ID="Value1RangeValidator" ControlToValidate="Value1" Type="Integer"
- MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />"
- Display="Dynamic" runat="server" /> </td>
- <td colspan="2">
- <asp:RequiredFieldValidator ID="Value2RequiredValidator" ControlToValidate="Value2"
- ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" />
- <asp:RangeValidator ID="Value2RangeValidator" ControlToValidate="Value2" Type="Integer"
- MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />"
- Display="Dynamic" runat="server" /> </td> <td>
-   </td> </tr> <tr align="center">
- <td colspan="4">
- <asp:Button ID="AddButton" Text="Add" OnClick="AddButton_Click" runat="server" />
- </td> <td>
- </td> </tr> </table> </form> </body>
- </html>
-
</head>
- <body> <form id="form1" runat="server"> <h3> RadTextBox Example
- </h3> <table> <tr> <td colspan="5">
- Enter Integer values into the text boxes. <br />
- Click the Add button To add the two values. <br />
- Click the Reset button To reset the text boxes. </td>
- </tr> <tr> <td colspan="5">
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Gets or sets the group of controls for which the ra.a.d.input control causes
- validation when it posts back to the server.
-
-
- The group of controls for which the RadInput control causes validation when it
- posts back to the server. The default value is an empty string ("").
-
-
- Validation groups allow you to assign validation controls on a page to a
- specific category. Each validation group can be validated independently from other
- validation groups on the page. Use the ValidationGroup property to specify the name
- of the validation group for which the RadInput control causes validation when it
- posts back to the server.
- This property has an effect only when the CausesValidation property is set to
- true. When you specify a value for the ValidationGroup property, only the
- validation controls that are part of the specified group are validated when the
- RadInput control posts back to the server. If you do not specify a value for
- this property and the CausesValidation property is set to true, all validation
- controls on the page that are not assigned to a validation group are validated when
- the control posts back to the server.
- This property cannot be set by themes or style sheet themes.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0
-
-
-
-
- Gets the style properties for RadInput when when the control is
- empty.
-
-
- A Telerik.WebControls.TextBoxStyle object that represents the style properties
- for RadInput control. The default value is an empty TextBoxStyle object.
-
-
- The following code example demonstrates how to set EmptyMessageStyle
- property:
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
- Use this property to provide a custom style for the empty message state of
- RadInput control. Common style attributes that can be adjusted include
- foreground color, background color, font, and alignment within the RadInput.
- Providing a different style enhances the appearance of the RadInput
- control.
- Empty message style properties in the RadInput control are inherited from
- one style property to another through a hierarchy. For example, if you specify a
- red font for the EnabledStyle property, all other style properties in the
- RadInput control will also have a red font. This allows you to provide a common
- appearance for the control by setting a single style property. You can override the
- inherited style settings for an item style property that is higher in the hierarchy
- by setting its style properties. For example, you can specify a blue font for the
- FocusedStyle property, overriding the red font specified in the EnabledStyle
- property.
- To specify a custom style, place the <EmptyMessageStyle> tags between
- the opening and closing tags of the RadInput control. You can then list the
- style attributes within the opening <EmptyMessageStyle> tag.
-
-
-
- Gets the style properties for focused RadInput control.
-
- A Telerik.WebControls.TextBoxStyle object that represents the style properties
- for focused RadInput control. The default value is an empty TextBoxStyle
- object.
-
-
- The following code example demonstrates how to set FocusedStyle
- property:
-
-
-
- Use this property to provide a custom style for the focused RadInput
- control. Common style attributes that can be adjusted include foreground color,
- background color, font, and alignment within the RadInput. Providing a different
- style enhances the appearance of the RadInput control.
- Focused style properties in the RadInput control are inherited from one
- style property to another through a hierarchy. For example, if you specify a red
- font for the EnabledStyle property, all other style properties in the RadInput
- control will also have a red font. This allows you to provide a common appearance
- for the control by setting a single style property. You can override the inherited
- style settings for an item style property that is higher in the hierarchy by
- setting its style properties. For example, you can specify a blue font for the
- FocusedStyle property, overriding the red font specified in the EnabledStyle
- property.
- To specify a custom style, place the <FocusedStyle> tags between the
- opening and closing tags of the RadInput control. You can then list the style
- attributes within the opening <FocusedStyle> tag.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets the style properties for disabled RadInput control.
-
- A Telerik.WebControls.TextBoxStyle object that represents the style properties
- for disabled RadInput control. The default value is an empty TextBoxStyle
- object.
-
-
- The following code example demonstrates how to set
- DisabledStyle property:
-
-
-
- Use this property to provide a custom style for the disabled RadInput
- control. Common style attributes that can be adjusted include foreground color,
- background color, font, and alignment within the RadInput. Providing a different
- style enhances the appearance of the RadInput control.
- Disabled style properties in the RadInput control are inherited from one
- style property to another through a hierarchy. For example, if you specify a red
- font for the EnabledStyle property, all other style properties in the RadInput
- control will also have a red font. This allows you to provide a common appearance
- for the control by setting a single style property. You can override the inherited
- style settings for an item style property that is higher in the hierarchy by
- setting its style properties. For example, you can specify a blue font for the
- DisabledStyle property, overriding the red font specified in the EnabledStyle
- property.
- To specify a custom style, place the <DisabledStyle> tags between the
- opening and closing tags of the RadInput control. You can then list the style
- attributes within the opening <DisabledStyle> tag.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets the style properties for invalid state of RadInput control.
-
- A Telerik.WebControls.TextBoxStyle object that represents the style properties
- for invalid RadInput control. The default value is an empty TextBoxStyle
- object.
-
-
- The following code example demonstrates how to set InvalidStyle
- property:
-
-
-
- Use this property to provide a custom style for the invalid state RadInput
- control. Common style attributes that can be adjusted include foreground color,
- background color, font, and alignment within the RadInput. Providing a different
- style enhances the appearance of the RadInput control.
- Enabled style properties in the RadInput control are inherited from one
- style property to another through a hierarchy. For example, if you specify a red
- font for the EnabledStyle property, all other style properties in the RadInput
- control will also have a red font. This allows you to provide a common appearance
- for the control by setting a single style property. You can override the inherited
- style settings for an item style property that is higher in the hierarchy by
- setting its style properties. For example, you can specify a blue font for the
- InvalidStyle property, overriding the red font specified in the EnabledStyle
- property.
- To specify a custom style, place the <InvalidStyle> tags between the
- opening and closing tags of the RadInput control. You can then list the style
- attributes within the opening <InvalidStyle> tag.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets the style properties for hovered RadInput control.
-
- A Telerik.WebControls.TextBoxStyle object that represents the style properties
- for hovered RadInput control. The default value is an empty TextBoxStyle
- object.
-
-
- The following code example demonstrates how to set HoveredStyle
- property:
-
-
-
- Use this property to provide a custom style for the hovered RadInput
- control. Common style attributes that can be adjusted include foreground color,
- background color, font, and alignment within the RadInput. Providing a different
- style enhances the appearance of the RadInput control.
- Hovered style properties in the RadInput control are inherited from one
- style property to another through a hierarchy. For example, if you specify a red
- font for the EnabledStyle property, all other style properties in the RadInput
- control will also have a red font. This allows you to provide a common appearance
- for the control by setting a single style property. You can override the inherited
- style settings for an item style property that is higher in the hierarchy by
- setting its style properties. For example, you can specify a blue font for the
- HoveredStyle property, overriding the red font specified in the EnabledStyle
- property.
- To specify a custom style, place the <HoveredStyle> tags between the
- opening and closing tags of the RadInput control. You can then list the style
- attributes within the opening <HoveredStyle> tag.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
- Gets the style properties for enabled RadInput control.
-
- A Telerik.WebControls.TextBoxStyle object that represents the style properties
- for enabled RadInput control. The default value is an empty TextBoxStyle
- object.
-
-
- Use this property to provide a custom style for the enabled RadInput
- control. Common style attributes that can be adjusted include foreground color,
- background color, font, and alignment within the RadInput. Providing a different
- style enhances the appearance of the RadInput control.
- Enabled style properties in the RadInput control are inherited from one
- style property to another through a hierarchy. For example, if you specify a red
- font for the EnabledStyle property, all other style properties in the RadInput
- control will also have a red font. This allows you to provide a common appearance
- for the control by setting a single style property. You can override the inherited
- style settings for an item style property that is higher in the hierarchy by
- setting its style properties. For example, you can specify a blue font for the
- FocusedStyle property, overriding the red font specified in the EnabledStyle
- property.
- To specify a custom style, place the <EnabledStyle> tags between the
- opening and closing tags of the RadInput control. You can then list the style
- attributes within the opening <EnabledStyle> tag.
-
-
- The following code example demonstrates how to set EnabledStyle
- property:
-
-
-
-
- Gets control that contains the buttons of RadInput control
- The ShowButton or ShowSpinButton properties must be set to true
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Clears the selected date of the RadDateInput control and displays a blank date.
-
-
-
-
- Gets or sets a value that indicates the end of the century that is used to interpret
- the year value when a short year (single-digit or two-digit year) is entered in the input.
-
-
- The year when the century ends. Default is 2029.
-
-
- Having a value of 2029 indicates that a short year will be interpreted as a year between 1930 and 2029.
- For example 55 will be interpreted as 1955 but 12 -- as 2012
-
-
-
-
- Gets a value that indicates the start of the century that is used to interpret
- the year value when a short year (single-digit or two-digit year) is entered in the input.
-
-
- The year when the century starts. Default is 2029.
-
-
- Having a value of 2029 indicates that a short year will be interpreted as a year between 1930 and 2029.
- For example 55 will be interpreted as 1955 but 12 -- as 2012
-
-
-
-
- Gets or sets the display date format used by
- RadDateInput.(Visible when the control is not on focus.)
-
-
- You can examine DateTimeFormatInfo class for a list of all
- available format characters and patterns.
-
-
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDateInput1.DisplayDateFormat = "M/d/yyyy"; //Short date pattern. The same as "d".
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDateInput1.DisplayDateFormat = "M/d/yyyy" 'Short date pattern. The same as "d".
- End Sub
-
-
-
- A string specifying the display date format used by RadDateInput. The default
- value is "d" (short date format). If the DisplayDateFormat is left
- blank, the DateFormat will be used both for editing and
- display.
-
-
-
-
- Gets or sets the date and time format used by
- RadDateInput.
-
-
- A string specifying the date format used by RadDateInput. The
- default value is "d" (short date format).
-
-
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDateInput1.DateFormat = "M/d/yyyy"; //Short date pattern. The same as "d".
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDateInput1.DateFormat = "M/d/yyyy" 'Short date pattern. The same as "d".
- End Sub
-
-
-
-
- Gets or sets the date content of RadDateInput.
-
- A DateTime object that represents the selected
- date. The default value is MinDate.
-
-
- The following example demonstrates how to use the SelectedDate
- property to set the content of RadDateInput.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDateInput1.SelectedDate = DateTime.Now;
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDateInput1.SelectedDate = DateTime.Now
- End Sub
-
-
-
-
-
- Gets or sets the date content of RadDateInput in a
- database-friendly way.
-
-
- A DateTime object that represents the selected
- date. The default value is MinDate.
-
-
- The following example demonstrates how to use the SelectedDate
- property to set the content of RadDateInput.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDateInput1.DbSelectedDate = tableRow["BirthDate"];
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDateInput1.DbSelectedDate = tableRow("BirthDate")
- End Sub
-
-
-
- This property behaves exactly like the SelectedDate property.
- The only difference is that it will not throw an exception if the new value is null or
- DBNull. Setting a null value will revert the selected date to the MinDate value.
-
-
-
-
- Gets or sets the culture used by RadDateInput to format the
- date.
-
-
- A CultureInfo object that
- represents the current culture used. The default value is
- System.Threading.Thread.CurrentThread.CurrentUICulture.
-
-
- The following example demonstrates how to use the Culture
- property.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDateInput1.Culture = new CultureInfo("en-US");
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDateInput1.Culture = New CultureInfo("en-US")
- End Sub
-
-
-
-
-
- This property is no longer used. The recomended alternative is the Text property.
-
-
-
-
- Gets or sets the smallest date value allowed by
- RadDateInput.
-
-
- A DateTime object that represents the smallest
- date value by RadDateInput. The default value is 1/1/1980.
-
-
-
-
- Gets or sets the largest date value allowed by
- RadDateInput.
-
-
- A DateTime object that represents the largest
- date value allowed by RadDateInput. The default value is
- 12/31/2099.
-
-
-
- Used to determine if RadDateInput is empty.
-
- true if the date is empty; otherwise false.
-
-
-
-
- Gets or sets the JavaScript event handler fired whenever the date of
- RadDateInput changes.
-
-
- A string specifying the name of the JavaScript event handling routine. The
- default value is empty string ("").
-
-
- The event handler function is called with 2 parameters:
-
- A reference to the RadDateInput object, which triggered
- the event;
-
- An event arguments object that contains the following properties:
-
-
OldDate - The old date of the
- RadDateInput
-
NewDate - The new date of the
- RadDateInput
-
-
-
-
-
- This example demonstrates the usage of the
- OnClientDateChanged property.
-
-
-
-
-
- Summary description for AutoPostBackControl.
-
-
-
-
- Without AutoPostBack
-
- 0
-
-
-
- Automatically postback to the server after the Date or Time is modified.
-
- 1
-
-
-
- Automatically postback to the server after the Time is modified.
-
- 2
-
-
-
- Automatically postback to the server after the Date is modified.
-
- 3
-
-
-
- Internal enumeration used by the component
-
-
-
- Specifies the type of a selector sell.
-
-
-
- Rendered as the first cell in a row. When clicked if UseRowHeadersAsSelectors is true,
- it will select the entire row.
-
-
-
-
- Rendered as the first cell in a column. When clicked if UseColumnHeadersAsSelectors is true,
- it will select the entire column.
-
-
-
-
- Rendered in the top left corner of the calendar view. When clicked if EnableViewSelector is true,
- it will select the entire view.
-
-
-
-
- Summary description for MonthLayout.
- Layout_7columns_x_6rows - horizontal layout
- Layout_14columns_x_3rows - horizontal layout
- Layout_21columns_x_2rows - horizontal layout
- Layout_7rows_x_6columns - vertical layout, required when UseColumnHeadersAsSelectors is true and Orientation is set to RenderInColumns.
- Layout_14rows_x_3columns - vertical layout, required when UseColumnHeadersAsSelectors is true and Orientation is set to RenderInColumns.
- Layout_21rows_x_2columns - vertical layout, required when UseColumnHeadersAsSelectors is true and Orientation is set to RenderInColumns.
-
-
-
-
- Allows the calendar to display the days in a 7 by 6 matrix.
-
- 1
-
-
-
- Alows the calendar to display the days in a 14 by 3 matrix.
-
- 2
-
-
-
- Allows the calendar to display the days in a 21 by 2 matrix.
-
- 4
-
-
-
- Allows the calendar to display the days in a 7 by 6 matrix, required when UseColumnHeadersAsSelectors is true and Orientation is set to RenderInColumns.
-
- 8
-
-
-
- Allows the calendar to display the days in a 14 by 3 matrix, required when UseColumnHeadersAsSelectors is true and Orientation is set to RenderInColumns.
-
- 16
-
-
-
- Allows the calendar to display the days in a 21 by 2 matrix, required when UseColumnHeadersAsSelectors is true and Orientation is set to RenderInColumns.
-
- 32
-
-
-
- Summary description for Orientation.
- RenderInRows - Renders the calendar data row after row.
- RenderInColumns - Renders the calendar data column after column.
- None - Enforces fallback to the default Orientation for Telerik RadCalendar.
-
-
-
-
- Renders the calendar data row after row.
-
- 1
-
-
-
- RenderInColumns - Renders the calendar data column after column.
-
- 3
-
-
-
- Describes how RadCalendar will handle its layout, and how will
- react to user interaction. Interactive - user is allowed to select dates, navigate,
- etc. Preview - does not allow user interaction, for presentation purposes only.
-
-
-
-
- Interactive - user is allowed to select dates, navigate, etc.
-
- 1
-
-
-
- Preview - does not allow user interaction, for presentation purposes only.
-
- 2
-
-
-
- Summary description for RecurringEvents.
- DayInMonth - Only the day part of the date is taken into account. That gives the ability to serve events repeated every month on the same day.
- DayAndMonth - The month and the day part of the date is taken into account. That gives the ability to serve events repeated in a specific month on the same day.
- Today - gives the ability to control the visual appearace of today's date.
- None - Default value, means that the day in question is a single point event, no recurrences.
-
-
-
-
- Only the day part of the date is taken into account. That gives the ability to serve events repeated every month on the same day.
-
- 1
-
-
-
- The month and the day part of the date are taken into account. That gives the ability to serve events repeated in a specific month on the same day.
-
- 2
-
-
-
- The week day is taken into account. That gives the ability to serve events repeated in a specific day of the week.
-
- 4
-
-
-
- The week day and the month are taken into account. That gives the ability to serve events repeated in a specific week day in a specific month.
-
- 8
-
-
-
- Gives the ability to control the visual appearace of today's date.
-
- 16
-
-
-
- The week number, the weekday (Mon, Tue, etc.) and the month are taken into account. That gives the ability to serve public holiday events
- repeated each year (e.g. Martin Luther King Jr. Day is observed on the third Monday of January each year
- so you would specify as a date Jan 21st, 2008 (or Jan 19th, 2009 -- it would have the same effect).
-
- 32
-
-
-
- Default value, means that the day in question is a single point event, no recurrence.
-
- 64
-
-
- Specifies the type of a selector sell.
-
-
-
- Rendered as the first cell in a row. When clicked, it will select the entire
- row.
-
-
-
-
- Rendered as the first cell in a column. When clicked, it will select the entire
- column.
-
-
-
-
- Rendered in the top left corner of the calendar view. When clicked, it will
- select the entire view.
-
-
-
-
- Defines the JavaScript functions (client-side event handlers) that are invoked
- when specific client-side event is raised.
-
-
-
-
- This class implements the PropertyBag "enabled" base object class, from which all other
- classes in Telerik RadCalendar descend, excluding those that are descendents of PropertiesControl.
-
-
-
-
- Event fired after the RadCalendar client object has been completely initialized.
-
-
-
-
- The event is fired immediately after the page onload event.
-
-
-
-
- Event fired when a valid date is being selected.
- Return false to cancel selection.
-
-
-
-
- Event fired after a valid date has been selected. Can be used in combination with
- OnDateClick for maximum convenience. This event can be used to conditionally process the
- selected date or any related event with it on the client.
-
-
-
-
- Event fired when a calendar cell, representing a date is clicked. This event is not the same as
- OnDateSelected. One can have an OnDateClick event for a disabled or read only calendar
- cell which does not allow.s OnDateSelected event to be fired.
- This event can be used to conditionally process some information/event based on the clicked
- date.
- Return false to cancel the click event.
-
-
-
-
- Event fired when a calendar row header is clicked. This event is not the same as
- OnDateClick. One can have an OnRowHeaderClick event for a disabled or read only calendar
- cell which does not allow to select calendar dates.
- This event can be used to conditionally process some information/event based on the clicked
- row header.
- Return false to cancel the click event.
-
-
-
-
- Event fired when a calendar column header is clicked. This event is not the same as
- OnDateClick. One can have an OnColumnHeaderClick event for a disabled or read only calendar
- cell which does not allow selection of calendar dates.
- This event can be used to conditionally process some information/event based on the clicked
- column header.
- Return false to cancel the click event.
-
-
-
-
- Event fired when a calendar view selector is clicked. This event is not the same as
- OnDateClick. One can have an OnViewSelectorClick event for a disabled or read only calendar
- cell which does not allow selection of calendar cell.
- This event can be used to conditionally process some information/event based on the clicked
- view selector.
- Return false to cancel the click event.
-
-
-
-
- Event fired when the calendar view is about to change.
- Return false to cancel the event.
-
-
-
-
- Event fired when the calendar view has changed. Generally
- the event is raised as a result of using the built-in navigation controls. Event is
- raised before the results are rendered, so that custom logic could be executed, and the
- change could be prevented if necessary. There is no way to find whether the operation
- was accomplished successfully. This event can be used to preprocess some conditions or
- visual styles/content before the final rendering of the calendar. Return false to
- cancel the event.
-
-
-
-
- Event fired for every calendar day cell when the calendar is rendered as a result of a client-side navigation (i.e. only in OperationType="Client").
- This event mimics the server-side DayRender event -- gives final control over the output of a specific calendar cell.
- This event can be used to apply final changes to the output (content and visial styles) just before the content is displayed.
-
-
-
-
- Summary description for DatePickerClientEvents.
-
-
-
-
-
- Gets or sets the name of the client-side event handler that is executed whenever
- the selected date of the datepicker is changed.
-
-
-
- [ASPX/ASCX]
-
-
- <script type="text/javascript" > function DatePicker_OnDateSelected(pickerInstance, args) { alert("The picker date has been chanded from " + args.OldDate + " to " + args.NewDate); } </script> <radCln:RadDatePicker ID="RadDatePicker1" runat="server" > <ClientEvents OnDateSelected="DatePicker_OnDateSelected" /> </radCln:RadDatePicker>
-
-
-
-
-
-
- Gets or sets the name of the client-side event handler that is executed prior to
- opening the calendar popup and its synchronizing with the DateInput value.
-
-
- There can be some conditions you do want not to open the calendar popup on
- click of the popup button. Then you should cancel the event either by return
- false; or set its argument args.CancelOpen = true;
-
- Set the args.CancelSynchronize = true; to override the default
- DatePicker behavior of synchronizing the date in the DateInput and Calendar
- controls. This is useful for focusing the Calendar control on a date different from
- the DateInput one.
-
-
-
- There can be some conditions you do want not to close the calendar popup on
- click over it. Then you should cancel the event either by return false; or
- set its argument args.CancelClose = true;
-
-
-
-
-
- Arguments class used with the DayRender event.
-
-
-
-
- Gets a reference to the TableCell object that represents the specified day to render.
-
-
-
-
- Gets a reference to the RadCalendarDay object that represents the specified day to render.
-
-
-
-
- Gets a reference to the MonthView object that represents the current View, corresponding to the specified day to render.
-
-
-
-
- Arguments class used when the DefaultViewChanged event is fired.
-
-
-
-
- Gets the CalendarView instance that was the default one prior to the rise of DefaultViewChanged
- event.
-
-
-
-
- Gets the new default CalendarView instance set by the DefaultViewChanged event.
-
-
-
-
- Arguments class used with the DayRender event.
-
-
-
-
- Gets a reference to the TableCell object that represents the specified day to render.
-
-
-
-
- Gets a reference to the RadCalendarDay object that represents the specified day to render.
-
-
-
-
- Provides data for the SelectedDateChanged event of the DatePicker control.
-
-
-
-
- Arguments class used when the SelectionChanged event is fired.
-
-
-
-
- Gets a reference to the SelectedDates collection, represented by the Telerik RadCalendar component
- that rise the SelectionChanged event.
-
-
-
-
- The MonthYearFastNavigationSettings class can be used to configure RadCalendar's
- client-side fast navigation.
-
-
-
- Gets or sets the value of the "Today" button caption;
-
- This property can be used to localize the button caption. The default is
- "Today".
-
-
-
- Gets or sets the value of the "OK" button caption;
-
- This property can be used to localize the button caption. The default is
- "OK".
-
-
-
- Gets or sets the value of the "Cancel" button caption;
-
- This property can be used to localize the button caption. The default is
- "Cancel".
-
-
-
- Gets or sets the value of the "Date is out of range" error message.
-
- This property can be used to localize the message the user sees when she tries to navigate to a date outside the allowed range.
- The default is "Date is out of range.".
-
-
-
- Gets or sets the value indicating whether the Today button should perform date selection or simple navigation.
-
- The default value is false (i.e. Today button works as a navigation enhancement only).
-
-
-
- Gets or sets whether the screen boundaries should be taken into consideration
- when the Fast Navigation Popup is displayed.
-
-
-
- Summary description for PropertyItem.
-
-
-
-
- Wrapper class for System.DateTime, which allows implementing persistable DateTime collections
- like DateTimeCollection.
-
-
-
-
- The System.DateTime represented by this RadDate wrapper class.
-
-
-
-
- The control that toggles the calendar popup.
- You can customize the appearance by setting the object's properties.
-
-
-
-
- Gets or sets the popup button image URL.
-
-
-
-
- Gets or sets the popup button hover image URL.
-
-
-
-
- RadDatePicker class
-
-
-
-
- Override this method to provide any last minute configuration changes. Make sure you call the base implementation.
-
-
-
-
- Override this method to provide any last minute configuration changes. Make sure you call the base implementation.
-
-
-
-
- Clears the selected date of the RadDatePicker control and displays a blank date.
-
-
-
- IPostBackDataHandler implementation
-
-
- Gets or sets default path for the grid images when EnableEmbeddedSkins is set to false.
- A string containing the path for the grid images. The default is string.Empty.
-
-
-
-
-
-
-
-
- Occurs after all child controls of the DatePicker control have been created.
- You can customize the control there, and add additional child controls.
-
-
-
-
- Occurs when the selected date of the DatePicker changes between posts to the server.
-
-
-
-
- Gets the RadCalendar instance of the datepicker control.
-
-
-
-
- Gets the RadDateInput instance of the datepicker control.
-
-
-
-
- Gets the DatePopupButton instance of the datepicker control.
- You can use the object to customize the popup button's appearance and behavior.
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.
-
-
- Setting this property to true will make RadDatePicker postback to the server
- on date selection through the Calendar or the DateInput components.
-
-
- The default value is false.
-
-
-
- Gets or sets the direction in which the popup Calendar is displayed,
- with relation to the DatePicker control.
-
-
- Gets or sets whether the screen boundaries should be taken into consideration
- when the Calendar or TimeView are displayed.
-
-
- Gets or sets the z-index style of the control's popups
-
-
- Gets or sets the date content of RadDatePicker.
-
- A DateTime object that represents the selected
- date. The default value is MinDate.
-
-
- The following example demonstrates how to use the SelectedDate
- property to set the content of RadDatePicker.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDatePicker1.SelectedDate = DateTime.Now;
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDatePicker1.SelectedDate = DateTime.Now
- End Sub
-
-
-
-
-
- This property is used by the RadDateInput's internals only. It is subject to
- change in the future versions. Please do not use.
-
-
-
- Gets or sets the date content of RadDatePicker in a database friendly way.
-
- A DateTime object that represents the selected
- date. The default value is null (Nothing in VB).
-
-
- The following example demonstrates how to use the DbSelectedDate
- property to set the content of RadDatePicker.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDatePicker1.DbSelectedDate = tableRow["BirthDate"];
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDatePicker1.DbSelectedDate = tableRow("BirthDate")
- End Sub
-
-
-
- This property behaves exactly like the SelectedDate property. The only difference
- is that it will not throw an exception if the new value is null or DBNull. Setting a
- null value will internally revert the SelectedDate to the null value, i.e. the input value will be empty.
-
-
-
-
- Used to determine if RadDatePicker is empty.
-
-
- true if the date is empty; otherwise false.
-
-
-
-
- Enables or disables typing in the date input box.
-
-
- true if the user should be able to select a date by typing in the date input box; otherwise
- false. The default value is true.
-
-
-
-
- Gets or sets whether the popup control (Calendar or TimeView) is displayed when the DateInput textbox is focused.
-
-
- The default value is false.
-
-
-
-
- Gets or sets the minimal range date for selection.
- Selecting a date earlier or equal to that will not be allowed.
-
-
- This property has a default value of 1/1/1980
-
-
-
-
- Gets or sets the latest valid date for selection.
- Selecting a date later than that will not be allowed.
-
-
- This property has a default value of 12/31/2099
-
-
-
- Gets or sets the culture used by RadDatePicker to format the date.
-
- A CultureInfo object that represents the current culture used. The default value is System.Threading.Thread.CurrentThread.CurrentUICulture.
-
-
- The following example demonstrates how to use the Culture
- property.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDatePicker1.Culture = new CultureInfo("en-US");
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDatePicker1.Culture = New CultureInfo("en-US")
- End Sub
-
-
-
-
-
- Gets or sets the ID of the calendar that will be used for picking dates. This
- property allows you to configure several datepickers to use a single RadCalendar
- instance.
-
-
- RadDatePicker will look for the RadCalendar instance in a way similar to how
- ASP.NET validators work. It will not go beyond the current naming container which
- means that you will not be able to configure a calendar that is inside a control in
- another naming container. You can still share a calendar, but you will have to pass
- a direct object reference via the SharedCalendar
- property.
-
- The string ID of the RadCalendar control if set; otherwise String.Empty.
-
-
-
- Gets or sets the reference to the calendar that will be used for picking dates.
- This property allows you to configure several datepickers to use a single RadCalendar
- instance.
-
- The RadCalendar instance if set; otherwise null;
-
- This property is not accessible from the VS.NET designer and you will have to
- set it from the code-behind. It should be used when the shared calendar instance is
- in another naming container or is created dynamically at runtime.
-
-
-
-
- Gets or sets the date that the
- Calendar uses for
- focusing itself whenever the
- RadDateInput component of
- the RadDatePicker is
- empty.
-
-
-
-
- Gets or sets the width of the datepicker in pixels.
-
-
-
-
- Gets or sets an instance of
- DatePickerClientEvents
- class which defines the JavaScript functions (client-side event handlers) that are
- invoked when specific client-side events are raised.
-
-
-
-
- RadDateTimePicker class
-
-
-
-
- This property is used by the RadDateTimeInput's internals only. It is subject to
- change in the future versions. Please do not use.
-
-
-
-
- Gets the RadTimeView instance of the datetimepicker control.
-
-
-
-
- Gets the TimePopupButton instance of the RadDateTimeView
- control.
-
-
- You can use the object to customize the popup button's appearance and
- behavior.
-
-
-
-
- Gets or sets a value indicating whether a postback to the server
- automatically occurs when the user interacts with the control.
-
- The default value is false.
-
- Setting this property to true will make RadDateTimePicker postback to the server
- on date selection through the Calendar and Time popups or the DateInput
- components.
-
-
-
-
- Gets or sets the culture used by RadDateTimePicker to format the date and time
- value.
-
-
- A CultureInfo object that
- represents the current culture used. The default value is
- System.Threading.Thread.CurrentThread.CurrentUICulture.
-
-
- The following example demonstrates how to use the Culture
- property.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadDateTimePicker1.Culture = new CultureInfo("en-US");
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadDateTimePicker1.Culture = New CultureInfo("en-US")
- End Sub
-
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically
- occurs when the user changes the list selection.
-
- The default value is None
-
- Set this to Both, TimeView or Calendar if the server needs to capture the
- selection changed event.
- This property is effective only for RadDateTimePicker; for RadTimePicker use the AutoPostBack property.
-
-
-
-
- Gets or sets the ID of the timeview that will be used for picking time. This
- property allows you to configure several datetimepickers to use a single RadTimeView
- instance.
-
-
- RadDateTimePicker will look for the RadTimeView instance in a way similar to how
- ASP.NET validators work. It will not go beyond the current naming container which
- means that you will not be able to configure a timeview that is inside a control in
- another naming container. You can still share a timeview, but you will have to pass
- a direct object reference via the SharedTimeView
- property.
-
- The string ID of the RadTimeView if set; otherwise String.Empty.
-
-
-
- Gets or sets the reference to the timeview that will be used for picking time.
- This property allows you to configure several datetimepickers to use a single RadTimeView
- instance.
-
- The RadTimeView instance if set; otherwise null;
-
- This property is not accessible from the VS.NET designer and you will have to
- set it from the code-behind. It should be used when the shared timeview instance is
- in another naming container or is created dynamically at runtime.
-
-
-
-
- Occurs when an item is data bound to the RadTimeView
- control.
-
-
- The ItemDataBound event is raised after an item is data
- bound to the RadTimeView control. This event provides you with the
- last opportunity to access the data item before it is displayed on the client.
- After this event is raised, the data item is no longer available.
-
-
- [ASPX]
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC
- "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1"
- runat="server">
- <div>
- <radCln:RadTimePicker
- OnItemDataBound=
- "RadTimePicker1_ItemDataBound"
- ID="RadTimePicker1"
- runat="server">
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
- using System;
- using System.Data;
- using System.Configuration;
- using System.Web;
- using System.Web.Security;
- using System.Web.UI;
- using System.Web.UI.WebControls;
- using System.Web.UI.WebControls.WebParts;
- using System.Web.UI.HtmlControls;
-
- public partial class _Default : System.Web.UI.Page
- {
- protected void RadTimePicker1_ItemDataBound(object sender, Telerik.WebControls.Base.Calendar.Events.TimePickerEventArgs e)
- {
- if (e.Item.ItemType == ListItemType.AlternatingItem)
- {
- e.Item.Controls.Add(new LiteralControl("AlternatingItem"));
- }
- }
- }
-
-
- Imports System
- Imports System.Data
- Imports System.Configuration
- Imports System.Web
- Imports System.Web.Security
- Imports System.Web.UI
- Imports System.Web.UI.WebControls
- Imports System.Web.UI.WebControls.WebParts
- Imports System.Web.UI.HtmlControls
- Public Class _Default
- Inherits System.Web.UI.Page
-
- Protected Sub RadTimePicker1_ItemDataBound(ByVal sender As Object, ByVal e As Telerik.WebControls.Base.Calendar.Events.TimePickerEventArgs)
- If (e.Item.ItemType = ListItemType.AlternatingItem) Then
- e.Item.Controls.Add(New LiteralControl("AlternatingItem"))
- End If
- End Sub
- End Class
-
-
-
-
-
- Occurs on the server when an item in the RadTimeView control is
- created.
-
-
- The ItemCreated event is raised when an item in the
- RadTimeView control is created, both during round-trips and at the
- time data is bound to the control.
- The ItemCreated event is commonly used to control the
- content and appearance of a row in the RadTimeView control.
-
-
- The following code example demonstrates how to
- specify and code a handler for the ItemCreated event to set the CSS styles on the
- RadTimeView.
- [ASPX]
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC
- "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- <style type="text/css">
- .TimeCss
- {
- background-color: Red;
- }
- .AlternatingTimeCss
- {
- background-color: Yellow;
- }
- </style>
- </head>
- <body>
- <form id="form1"
- runat="server">
- <div>
- <radCln:RadTimePicker
- OnItemCreated=
- "RadTimePicker1_ItemCreated"
- ID="RadTimePicker1"
- runat="server">
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
- protected void RadTimePicker1_ItemCreated(object sender, Telerik.WebControls.Base.Calendar.Events.TimePickerEventArgs e)
- {
- if (e.Item.ItemType == ListItemType.Item)
- {
- e.Item.CssClass = "TimeCss";
- }
-
- if (e.Item.ItemType == ListItemType.AlternatingItem)
- {
- e.Item.CssClass = "AlternatingTimeCss";
- }
- }
-
-
- Protected Sub RadTimePicker1_ItemCreated(sender As Object, e As Telerik.WebControls.Base.Calendar.Events.TimePickerEventArgs)
- If e.Item.ItemType = ListItemType.Item Then
- e.Item.CssClass = "TimeCss"
- End If
-
- If e.Item.ItemType = ListItemType.AlternatingItem Then
- e.Item.CssClass = "AlternatingTimeCss"
- End If
- End Sub 'RadTimePicker1_ItemCreated
-
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.
-
-
- Setting this property to true will make RadTimePicker postback to the server
- on time selection through the TimeView or the DateInput components.
-
-
- The default value is false.
-
-
-
-
- RadTimeView class
-
-
-
-
- Restores view-state information from a previous page request that was saved by the SaveViewState method.
-
- The saved view state.
-
-
-
- Saves any server control view-state changes that have occurred since the time the page was posted back to the server.
-
- The saved view state.
-
-
- Gets a data bound list control that displays items using templates.
-
-
-
- Gets or sets DataList ReapeatDirection
-
-
-
- Gets or sets the template for alternating time cells in the RadTimeView.
-
- Use the AlternatingTimeTemplate property to control the
- contents of alternating items in the RadTimeView control. The
- appearance of alternating time cells is controlled by the
- AlternatingTimeStyle property.
- To specify a template for the alternating time cells, place the
- <AlternatingTimeTemplate> tags between the opening and closing tags of the
- RadTimeView control. You can then list the contents of the
- template between the opening and closing <AlternatingTimeTemplate>
- tags.
-
-
- The following code example demonstrates how to use the
- AlternatingTimeTemplate property to control the contents of
- alternating items in the RadTimeView control.
-
-
-
-
-
-
-
-
-
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView>
- <AlternatingTimeTemplate>
- <input type="button" id="button1" value='<%# DataBinder.Eval(((DataListItem)Container).DataItem, "time", "{0:t}") %>' />
- </AlternatingTimeTemplate>
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets the template for the footer section of the
- RadTimeView control.
-
-
- To specify a template for the footer section, place the
- <FooterTemplate> tags between the opening and closing tags of the
- RadTimeView control. You can then list the contents of the
- template between the opening and closing <FooterTemplate> tags.
- The ShowFooter property must be set to true for this property to be
- visible.
-
-
- The following code example demonstrates how to use the
- FooterTemplate property to control the contents of the footer
- section of the RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView ShowFooter="true">
- <FooterTemplate>
- <asp:Label ID="Label1" runat="server" Text="Footer"></asp:Label>
- </FooterTemplate>
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets the template for the heading section of the RadTimeView
- control.
-
-
- Use the HeaderTemplate property to control the contents of
- the heading section. The appearance of the header section is controlled by the
- HeaderStyle property.
- To specify a template for the heading section, place the
- <HeadingTemplate> tags between the opening and closing tags of the
- RadTimeView control. You can then list the contents of the
- template between the opening and closing <HeadingTemplate> tags.
- The ShowHeader property must be set to true for this property to be
- visible.
-
-
- The following code example demonstrates how to use the
- HeaderTemplate property to control the contents of the heading
- section of the RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView>
- <HeaderTemplate>
- <asp:Label ID="Label1" runat="server" Text="Header"></asp:Label>
- </HeaderTemplate>
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets the template for the heading section of the RadTimeView
- control.
-
-
- Use the HeaderTemplate property to control the contents of
- the heading section. The appearance of the header section is controlled by the
- HeaderStyle property.
- To specify a template for the heading section, place the
- <HeadingTemplate> tags between the opening and closing tags of the
- RadTimeView control. You can then list the contents of the
- template between the opening and closing <HeadingTemplate> tags.
- The ShowHeader property must be set to true for this property to be
- visible.
-
-
- The following code example demonstrates how to use the
- HeaderTemplate property to control the contents of the heading
- section of the RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView>
- <HeaderTemplate>
- <asp:Label ID="Label1" runat="server" Text="Header"></asp:Label>
- </HeaderTemplate>
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets the foreground color (typically the color of the text) of the
- RadTimeView control.
-
-
- A System.Drawing.Color that represents the foreground color of the control. The
- default is Color.Empty.
-
-
- Use the ForeColor property to specify the foreground color
- of the RadTimeView control. The foreground color is usually the
- color of the text. This property will render on browsers earlier than Microsoft
- Internet Explorer version 4.
- Note: On browsers that do not support styles, this property is rendered as a
- FONT element.
-
-
- On browsers that do not support styles, this property is rendered as a FONT
- element.
-
-
-
-
- Gets or sets the background color of the RadTimeView
- control.
-
-
- Use the BackColor property to specify the background color
- of the RadTimeView control. This property is set using a
- System.Drawing.Color object.
- In general, only controls that render as a <table> tag can display a
- background color in HTML 3.2, whereas almost any control can in HTML 4.0.
- For controls that render as a <span> tag (including Label, all
- validation controls, and list controls with their RepeatLayout property set to
- RepeatLayout.Flow), this property will work in Microsoft Internet Explorer version
- 5 or later, but not for Microsoft Internet Explorer version 4.
-
-
-
- Gets or sets the border color of the RadTimeView control.
-
- Use the BorderColor property to specify the border color of the
- RadTimeView control. This property is set using a System.Drawing.Color
- object.
-
-
- A System.Drawing.Color that represents the border color of the control. The
- default is Color.Empty, which indicates that this property is not set.
-
-
-
- Gets or sets the border style of the RadTimeView control.
-
- One of the BorderStyle enumeration values. The default is
- NotSet.
-
-
- Use the BorderStyle property to specify the border style for
- the RadTimeView control. This property is set using one of the
- BorderStyle enumeration values. The following table lists the
- possible values.
-
-
-
- Border Style
- Description
-
-
- NotSet
- The border style is not set.
-
-
- None
- No border
-
-
- Dotted
- A dotted line border.
-
-
- Dashed
- A dashed line border.
-
-
- Solid
- A solid line border.
-
-
- Double
- A solid double line border.
-
-
- Groove
- A grooved border for a sunken border
- appearance.
-
-
- Ridge
- A ridged border for a raised border
- appearance.
-
-
- Inset
- An inset border for a sunken control
- appearance.
-
-
-
- Note: This property will not render on some browsers.
-
-
-
- Gets or sets the border width of the RadTimeView control.
-
- A Unit that represents the border width of a RadTimeView control. The default
- value is Unit.Empty, which indicates that this property is not set.
-
-
- Use the BorderWidth property to specify a border width for a
- control.
- This property is set with a Unit object. If the Value property of the Unit
- contains a negative number, an exception is thrown.
-
-
-
-
- Gets or sets the cascading style sheet (CSS) class rendered by the
- RadTimeView on the client.
-
-
- The CSS class rendered by the RadTimeView control on the client.
- The default is String.Empty.
-
-
- Use the CssClass property to specify the CSS class to render on the client
- for the RadTimeView control. This property will render on browsers
- for all controls. It will always be rendered as the class attribute, regardless of
- the browser.
- For example, suppose you have the following RadTimeVeiw
- control declaration:
- <asp:TextBox id="TextBox1" ForeColor="Red" CssClass="class1" />
- The following HTML is rendered on the client for the previous
- RadTimeView control declaration:
-
-
-
- Gets or sets the height of the RadTimeView control.
-
- A Unit that represents the height of the RadTimeView
- control. The default is Empty.
-
-
- Use the Height property to specify the height of the
- RadTimeView control.
-
-
-
- Gets or sets the width of the RadTimeView control.
-
- A Unit that represents the width of the RadTimeView control. The
- default is Empty.
-
-
- Use the Width property to specify the width of the
- RadTimeView control.
-
-
-
-
- Gets the font properties associated with the RadTimeView
- control.
-
- A FontInfo that represents the font properties of the Web server control.
-
- Use the Font property to specify the font properties of the
- RadTimeView control. This property includes subproperties that can be
- accessed declaratively in the form of Property-Subproperty (for example Font-Bold) or
- programmatically in the form of Property.Subproperty (for example Font.Bold).
-
-
-
- Gets or sets default path for the grid images when EnableEmbeddedSkins is set to false.
- A string containing the path for the grid images. The default is string.Empty.
-
-
-
-
-
-
-
-
-
- Gets or sets a value that specifies whether the border between the cells of the
- RadTimeView control is displayed.
-
-
- One of the GridLines enumeration values. The default is
- Both.
-
-
- Use the GridLines property to specify whether the border between
- the cells of the data list control is displayed. This property is set with one of the
- GridLines enumeration values.
-
-
-
-
- Gets or sets the hetader associated with the RadTimeView
- control.
-
- Use HeaderText when UseAccessibleHeader is set to true
-
-
- Gets or sets the alignemt of the associated caption.
-
-
-
- Indicates that the control should use accessible header cells in its containing
- table control.
-
-
-
- Gets or sets the descriptive caption associated with the control.
-
-
-
- Occurs on the client when an time sell in the RadTimeView
- control is selected.
-
- The default value is String.Empty
-
- The following example demonstrates how to attach the
- OnClientSelectedEvent
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- <script language="javascript">
- function ClientTimeSelected(sender, args)
- {
- alert(args.oldTime);
- alert(args.newTime);
- }
- </script>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView OnClientTimeSelected="ClientTimeSelected">
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets the horizontal alignment of the RadTimeView
- control.
-
-
- One of the HorizontalAlign enumeration values. The default is
- NotSet.
-
-
- Use the HorizontalAlign property to specify the horizontal
- alignment of the data list control within its container. This property is set with one
- of the HorizontalAlign enumeration values.
-
-
-
-
- Gets or sets the amount of space between the contents of the cell and the cell's
- border.
-
-
- The distance (in pixels) between the contents of a cell and the cell's border.
- The default is -1, which indicates that this property is not set.
-
-
- Use the CellPadding property to control the spacing between
- the contents of a cell and the cell's border. The padding amount specified is added
- to all four sides of a cell.
- All cells in the same column of a data listing control share the same cell
- width. Therefore, if the content of one cell is longer than the content of other
- cells in the same column, the padding amount is applied to the widest cell. All
- other cells in the column are also set with this cell width.
- Similarly, all cells in the same row share the same height. The padding
- amount is applied to the height of the tallest cell in the row. All other cells in
- the same row are set with this cell height. Individual cell sizes cannot be
- specified.
- The value of this property is stored in view state.
-
-
-
-
- Gets or sets the distance between time cells of the
- RadTimeView.
-
-
- The distance (in pixels) between table cells. The default is -1, which indicates
- that this property is not set.
-
-
- Use the CellSpacing property to control the spacing between
- adjacent cells in a data listing control. This spacing is applied both vertically
- and horizontally. The cell spacing is uniform for the entire data list control.
- Individual cell spacing between each row or column cannot be specified.
- The value of this property is stored in view state.
-
-
-
-
- Gets or sets the number of columns to display in the RadTimeView
- control.
-
-
- Use this property to specify the number of columns that display items in the
- RadTimeView control. For example, if you set this property to 5, the
- RadTimeView control displays its items in five columns.
-
-
- The following code example demonstrates how to use the Columns
- property to specify the number of columns to display in the
- RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView Columns="5" >
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets a value indicating whether the footer section is displayed in
- the RadTimeView control.
-
-
- true if the footer section is displayed; otherwise, false. The default value is
- true, however this property is only examined when the FooterTemplate
- property is not a null reference (Nothing in Visual Basic).
-
-
- Use the ShowFooter property to specify whether the footer
- section is displayed in the RadTimeView control.
- You can control the appearance of the footer section by setting the
- FooterStyle property. The contents of the footer section are
- controlled by the FooterTemplate property.
-
-
- The following code example demonstrates how to use the
- ShowFooter property to display the footer section in the
- RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView ShowFooter="true" >
- <FooterTemplate>
- <asp:Label ID="Label1" runat="server" Text="Hello Footer!"></asp:Label>
- </FooterTemplate>
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets a value indicating whether the header section is displayed in the
- RadTimeView control.
-
-
- true if the header is displayed; otherwise, false. The default value is true,
- however this property is only examined when the HeaderTemplate
- property is not a null reference (Nothing in Visual Basic).
-
-
- Use the ShowHeader property to specify whether the header
- section is displayed in the RadTimeView control.
- You can control appearance of the header section by setting the
- HeaderStyle property. The contents of the header section are
- controlled by the HeaderTemplate property.
-
-
- The following code example demonstrates how to use the
- ShowHeader property to display the header section in the
- RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimeView ShowHeader="true">
- <HeaderTemplate>
- <asp:Label ID="Label1" runat="server" Text="Hello Header!"></asp:Label>
- </HeaderTemplate>
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
- Gets or sets the start time of the control.
-
-
-
- Provides information about a specific culture. The information includes the names
- for the culture, the writing system, the calendar used, and formatting for the
- times.
-
-
- The CultureInfo class renders culture-specific information,
- such as the associated language, sublanguage, country/region, calendar, and
- cultural conventions. This class also provides access to culture-specific instances
- of DateTimeFormatInfo, NumberFormatInfo, CompareInfo, and TextInfo. These objects
- contain the information required for culture-specific operations, such as casing,
- formatting dates and numbers, and comparing strings.
-
-
-
- ite
-
-
-
- Gets or sets the interval between StartTime and
- EndTime
-
-
-
- Gets or sets the format of the time.
-
- A custom Time format string consists of one or more custom Time format
- specifiers, and that format string defines the text representation of a DateTime
- object that is produced by a formatting operation.
- Custom Time format specifiers.
-
-
-
- h
- Represents the hour as a number from 1 through 12, that
- is, the hour as represented by a 12-hour clock that counts the whole
- hours since midnight or noon. Consequently, a particular hour after
- midnight is indistinguishable from the same hour after noon. The hour
- is not rounded, and a single-digit hour is formatted without a leading
- zero. For example, given a time of 5:43, this format specifier displays
- "5". For more information about using a single format specifier, see
- Using Single Custom Format Specifiers.
-
-
- hh, hh (plus any number of additional "h" specifiers)
- Represents the hour as a number from 01 through 12, that
- is, the hour as represented by a 12-hour clock that counts the whole
- hours since midnight or noon. Consequently, a particular hour after
- midnight is indistinguishable from the same hour after noon. The hour
- is not rounded, and a single-digit hour is formatted with a leading
- zero.
-
-
- H
- Represents the hour as a number from 0 through 23, that
- is, the hour as represented by a zero-based 24-hour clock that counts
- the hours since midnight. A single-digit hour is formatted without a
- leading zero.
-
-
- HH, HH (plus any number of additional "H" specifiers)
- Represents the hour as a number from 00 through 23, that
- is, the hour as represented by a zero-based 24-hour clock that counts
- the hours since midnight. A single-digit hour is formatted with a
- leading zero.
-
-
- m
- Represents the minute as a number from 0 through 59. The
- minute represents whole minutes passed since the last hour. A
- single-digit minute is formatted without a leading zero.
-
-
- mm, mm (plus any number of additional "m" specifiers)
- Represents the minute as a number from 00 through 59. The
- minute represents whole minutes passed since the last hour. A
- single-digit minute is formatted with a leading zero.
-
-
- s
- Represents the seconds as a number from 0 through 59. The
- second represents whole seconds passed since the last minute. A
- single-digit second is formatted without a leading zero.
-
-
- ss, ss (plus any number of additional "s" specifiers)
- Represents the seconds as a number from 00 through 59. The
- second represents whole seconds passed since the last minute. A
- single-digit second is formatted with a leading zero.
-
-
- t
- Represents the first character of the A.M./P.M. designator
- defined in the current
- System.Globalization.DateTimeFormatInfo.AMDesignator or
- System.Globalization.DateTimeFormatInfo.PMDesignator property. The A.M.
- designator is used if the hour in the time being formatted is less than
- 12; otherwise, the P.M. designator is used.
-
-
- tt, tt (plus any number of additional "t" specifiers)
- Represents the A.M./P.M. designator as defined in the
- current System.Globalization.DateTimeFormatInfo.AMDesignator or
- System.Globalization.DateTimeFormatInfo.PMDesignator property. The A.M.
- designator is used if the hour in the time being formatted is less than
- 12; otherwise, the P.M. designator is used.
-
-
-
-
- Standard Time Format Specifiers
-
-
-
- t
- ShortTimePattern - For example, the custom format string
- for the invariant culture is "HH:mm".
-
-
- T
- LongTimePattern - For example, the custom format string
- for the invariant culture is "HH:mm:ss".
-
-
-
-
-
-
-
- Gets the style properties for the time cells in the RadTimeView
- control.
-
-
- Use this property to provide a custom style for the items of the
- RadTimeView control. Common style attributes that can be adjusted
- include foreground color, background color, font, and content alignment within the
- cell. Providing a different style enhances the appearance of the
- RadTimeView control.
- If you specify a red font for the TimeStyle property, all
- other item style properties in the RadTimeView control will also
- have a red font. This allows you to provide a common appearance for the control by
- setting a single item style property. You can override the inherited style settings
- for an item style property that is higher in the hierarchy by setting its style
- properties. For example, you can specify a blue font for the
- AlternatingTimeStyle property, overriding the red font specified
- in the TimeStyle property.
- To specify a custom style for the items of the RadTimeView
- control, place the <TimeStyle> tags between the opening and closing tags of
- the RadTimeView control. You can then list the style attributes
- within the opening <TimeStyle> tag.
- You can also use the AlternatingTimeStyle property to provide a different
- appearance for the alternating items in the RadTimeView
- control.
-
-
- The following code example demonstrates how to use the TimeStyle
- property to specify a different background color for the time cells in the
- RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <div>
- <asp:DropDownList AutoPostBack="true" ID="DropDownList1" runat="server" OnSelectedIndexChanged="DropDownList1_SelectedIndexChanged">
- <asp:ListItem Text="Select" Value=""></asp:ListItem>
- <asp:ListItem Text="DarkGray" Value="DarkGray"></asp:ListItem>
- <asp:ListItem Text="Khaki" Value="Khaki"></asp:ListItem>
- <asp:ListItem Text="DarkKhaki" Value="DarkKhaki"></asp:ListItem>
- </asp:DropDownList>
- </div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimePopupButton ImageUrl="clock.gif" HoverImageUrl="clock.gif" />
- <TimeView Skin="None">
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
- using System;
- using System.Data;
- using System.Configuration;
- using System.Web;
- using System.Web.Security;
- using System.Web.UI;
- using System.Web.UI.WebControls;
- using System.Web.UI.WebControls.WebParts;
- using System.Web.UI.HtmlControls;
-
- public partial class _Default : System.Web.UI.Page
- {
- protected void DropDownList1_SelectedIndexChanged(object sender, EventArgs e)
- {
- this.RadTimePicker1.TimeView.TimeStyle.BackColor =
- System.Drawing.Color.FromName(this.DropDownList1.SelectedItem.Value);
- }
- }
-
-
-
-
-
- Gets the style properties for alternating time sells in the
- RadTimeView control.
-
-
- Use the AlternatingTimeStyle property to provide a custom
- style for the alternating time cells in the RadTimeView control.
- Common style attributes that can be adjusted include foreground color, background
- color, font, and content alignment within the cell. Providing a different style
- enhances the appearance of the RadTimeView control.
- If you specify a red font for the TimeStyle property, all
- other item style properties in the RadTimeView control will also
- have a red font. This allows you to provide a common appearance for the control by
- setting a single item style property. You can override the inherited style settings
- for an item style property that is higher in the hierarchy by setting its style
- properties. For example, you can specify a blue font for the
- AlternatingTimeStyle property, overriding the red font specified
- in the TimeStyle property.
- To specify a custom style for the alternating items, place the
- <AlternatingTimeStyle> tags between the opening and closing tags of the
- RadTimeView control. You can then list the style attributes within
- the opening <AlternatingTimeStyle> tag.
-
-
- The following code example demonstrates how to use the
- AlternatingTimeStyle property to specify a different background
- color for alternating items in the RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <div>
- <asp:DropDownList AutoPostBack="true" ID="DropDownList1" runat="server" OnSelectedIndexChanged="DropDownList1_SelectedIndexChanged">
- <asp:ListItem Text="Select" Value=""></asp:ListItem>
- <asp:ListItem Text="DarkGray" Value="DarkGray"></asp:ListItem>
- <asp:ListItem Text="Khaki" Value="Khaki"></asp:ListItem>
- <asp:ListItem Text="DarkKhaki" Value="DarkKhaki"></asp:ListItem>
- </asp:DropDownList>
- </div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimePopupButton ImageUrl="clock.gif" HoverImageUrl="clock.gif" />
- <TimeView Skin="None">
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
- using System;
- using System.Data;
- using System.Configuration;
- using System.Web;
- using System.Web.Security;
- using System.Web.UI;
- using System.Web.UI.WebControls;
- using System.Web.UI.WebControls.WebParts;
- using System.Web.UI.HtmlControls;
-
- public partial class _Default : System.Web.UI.Page
- {
- protected void DropDownList1_SelectedIndexChanged(object sender, EventArgs e)
- {
- this.RadTimePicker1.TimeView.AlternatingTimeStyle.BackColor =
- System.Drawing.Color.FromName(this.DropDownList1.SelectedItem.Value);
- }
- }
-
-
-
-
-
- Gets the style properties for the heading section of the
- RadTimeView control.
-
-
- Use this property to provide a custom style for the heading of the
- RadTimeView control. Common style attributes that can be adjusted
- include foreground color, background color, font, and content alignment within the
- cell. Providing a different style enhances the appearance of the
- RadTimeView control.
- To specify a custom style for the heading section, place the
- <HeaderStyle> tags between the opening and closing tags of the
- RadTimeView control. You can then list the style attributes within
- the opening <HeaderStyle> tag.
- Note: The ShowHeader property must be set
- to true for this property to be visible.
-
-
- The following code example demonstrates how to use the HeaderStyle
- property to specify a custom background color for the heading section of the
- RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimePopupButton ImageUrl="clock.gif" HoverImageUrl="clock.gif" />
- <TimeView Skin="None" ShowHeader="true">
- <HeaderStyle BackColor="red" />
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets the style properties for the footer section of the
- RadTimeView control.
-
-
- Use this property to provide a custom style for the footer section of the
- radTimeView control. Common style attributes that can be adjusted
- include foreground color, background color, font, and content alignment within the
- cell. Providing a different style enhances the appearance of the
- RadTimeView control.
- The FooterStyle property of the RadTimeView
- control inherits the style settings of the ControlStyle property. For example, if
- you specify a red font for the ControlStyle property, the
- FooterStyle property will also have a red font. This allows you to
- provide a common appearance for the control by setting a single style property. You
- can override the inherited style settings by setting the
- FooterStyle property. For example, you can specify a blue font for
- the FooterStyle property, overriding the red font specified in the
- ControlStyle property.
- To specify a custom style for the footer section, place the
- <FooterStyle> tags between the opening and closing tags of the
- RadTimeView control. You can then list the style attributes within
- the opening <FooterStyle> tag.
- Note: The ShowFooter property must be set
- to true for this property to be visible.
-
-
- The following code example demonstrates how to use the
- FooterStyle property to specify a custom background color for the
- footer section of the RadTimeView control.
-
- <%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
-
- <%@ Register Assembly="RadCalendar.Net2" Namespace="Telerik.WebControls" TagPrefix="radCln" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radCln:RadTimePicker
- ID="RadTimePicker1"
- runat="server">
- <TimePopupButton ImageUrl="clock.gif" HoverImageUrl="clock.gif" />
- <TimeView Skin="None" ShowFooter="true">
- <FooterStyle BackColor="Aqua" />
- </TimeView>
- </radCln:RadTimePicker>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- The control that toggles the TimeView popup.
- You can customize the appearance by setting the object's properties.
-
-
-
-
- Custom Type convertor that gives enhanced selection abilities for the properties that
- reffer to collections like CalendarDayCollection.
-
-
-
-
- Summary description for JsBuilder.
-
-
-
-
- Summary description for Utility.
-
-
-
-
- This static member is used translating .NET arrays to JS arrays.
- Acts like a compressor.
-
- The 1D array to compress
- The compressed string
-
-
-
- Converts an input 2D JavaScript array like [[5,10,2005],[6,10,2005],[7,10,2005]] into a DateTimeCollection.
-
- The DateTimeCollection that will be filled.
- The input string.
-
-
-
- RadCalendarDay represents a object that maps date value to corresponding visual settings.
- Also the object implements Boolean properties that represent the nature of the selected date -
- whether it is a weekend, disabled or selected in the context of the calendar. Mostly the values
- of those properties are set at runtime when a RadCalendarDay instance is constructed and passed
- to the DayRender event.
-
-
-
-
- Summary description for RichUITemplateControl.
-
-
-
-
- Reset all properties to their defaults.
-
-
-
-
- Persists the ID of the template used by this instance of RichUITemplateControl if
- any. The TemplateID could be used to index the Templates collection and instantiate
- the required template.
-
-
-
-
- Gets or sets the date represented by this RadCalendarDay.
-
-
-
-
- Gets the style properties for the RadCalendarDay
- instance.
-
-
- A TableItemStyle that contains the style properties for the RadCalendarDay instance.
-
-
-
-
- Gets or sets a value indicating whether the RadCalendarDay is qualified as available for selection.
-
-
-
-
- Gets or sets a value indicating whether the RadCalendarDay is selected
-
-
-
-
- Gets or sets a value indicating whether the RadCalendarDay is disabled
-
-
-
-
- Gets or sets a value indicating whether the RadCalendarDay represents the current date.
-
-
-
-
- Gets or sets a value indicating whether the RadCalendarDay settings are repeated/recurring through out the valid
- date range displayed by the calendar.
-
-
- The RecurringEvents enumeration determines which part of the date is handled (day or day and month).
-
-
-
-
- Gets or sets a value indicating whether the RadCalendarDay is mapped to a date that represents a non working
- day/weekend.
-
-
-
-
- Gets or sets the text displayed when the mouse pointer hovers over the calendar day.
-
-
-
-
- Summary description for BaseRenderer.
-
-
-
-
- Summary description for CalendarView.
-
-
-
-
- Returns an ArrayList of all properties of RadCalendar that are to be exported on the client.
-
-
-
-
-
- Summary description for CalendarView.
-
-
-
-
- Descendent of Control, DayTemplate implements an ITemplate wrapper, required for building
- collections of templates like CalendarDayTemplateCollection.
-
-
-
-
- This is the control that is used to instantiate any required template.
-
-
-
-
- The base class with common functionality needed by web chart controls for an image maps creation
-
-
-
-
- Gets a string of element path in a parent control order list hierarchy.
- For example, Legend has an index 4 in a Chart's order list, first legend item has an index 0 in Legend's order list.
- So result string will look like "4, 0"
-
- IOrdering element
- ArrayList with parent indexes
-
-
-
-
- Generates the image map HTML code
-
-
- HTML code with created image map
-
-
-
- Creates chart axes specific image maps code
-
- Chart axis
- StringBuilder to populate with image map HTML code
-
-
-
- Generates an image map string for a given IOrdering object and appends it to a given StringBuilder object
-
- IOrdering element
- The target StringBuilder object
- Disables a JavaScript post back function creation if only tool tip creation required
-
-
-
- Gets a figure name for a image map type for a different series types
-
- Series item
- The Active region index in a regions list
- Figure name
-
-
-
- Gets an appropriate HTML shape name by an internal figure name
-
- The charting Figure string value
- HTML shape name (rect, circle, poly)
-
-
-
- Gets the image maps coordinates
-
- Graphics Path object to get coordinates from
- Charting figure
- String of element coordinates in the image map separated by comma
-
-
-
- Returns a string that can be used in a client event to cause post back to
- the server. The reference string is defined by string argument of additional event information.
-
- A string of optional arguments to pass to the control that processes the post back.
- A string that, when treated as script on the client, initiates the post back.
-
-
-
- Checks if chart control has a Click event enabled
-
- True or False
-
-
-
- Generates image map HTML string
-
- HTML string
-
-
-
- The class represents the base functionality of the RadChart.
-
-
-
-
- Common chart components definitions
-
-
-
-
-
-
- MapMath method
-
- path
- path
-
-
-
- Control clone
-
-
-
-
-
- Chart object
-
-
-
-
- Path to the Temp folder
-
-
-
-
- Gets a value indicating whether scaling is enabled.
-
-
-
-
- Adds a new data series to the RadChart's series collection.
-
-
-
-
-
- Creates a new instance of RadChart.
-
-
-
-
- Restores control-state information from a previous page request that was saved by the SaveControlState() method.
-
- An System.Object that represents the control state to be restored
-
-
-
- Saves any server control state changes that have occurred since the time the page was posted back to the server.
-
- Returns the chart control's current state. If there is no state associated
- with the control, this method returns null.
-
-
-
- The control-state information
-
- Returns the chart control's current state as objects array
-
-
-
- Resets current chart's skin to default
-
-
-
-
- Loads user skin from a TextWriter object
-
-
-
-
-
- Exports current chart's settings into TextWriter object
-
-
-
-
-
- Saves the chart's state into XML file in the specified by fileName location.
-
- Path to the file
-
-
-
- Loads RadChart's settings and data from external XML file.
-
-
-
-
-
- Loads entire chart settings from a TextWriter object
-
-
-
-
-
- Exports current chart's skin into TextWriter object
-
-
-
-
-
- Removes the data series associated with the chart control.
-
-
-
-
- Removes all data series from the series collection without removing axis items.
-
-
-
-
- Removes the data series at the specified index.
-
-
-
-
-
- Gets a reference to the data series object at the specified index.
-
-
-
-
-
-
- Gets a reference to the data series object with the specified name.
-
-
-
-
-
-
- Gets a reference to the data series object with the specified color.
-
-
-
-
-
-
- Creates a new chart series and adds it to the series collection.
-
-
-
-
-
-
-
-
-
- Saves the chart with the specified file name.
-
-
-
-
-
- Saves the chart with the specified file name and the specified image format.
-
-
-
-
-
-
- Changes the DataSourceID property without DataBind method call
-
-
-
-
-
- Binds a data source to the invoked server control and all its child controls.
-
-
-
-
- Gets or sets a value indicating whether RadChart should automatically check for the
- ChartHttpHandler existence in the system.web section of the application configuration file.
-
-
- Set this property to false if you are running your application under IIS7 Integrated Mode
- and have set the validateIntegratedModeConfiguration flag that does not allow legacy
- HttpHandler registration under the system.web configuration section.
-
-
-
-
- Gets or sets a value indicating the URL to the ChartHttpHandler that is necessary for the correct operation
- of the RadChart control.
-
-
- Returns the URL of the ChartHttpHandler. The default value is "ChartImage.axd".
-
-
- Generally the default relative value should work as expected and you do not need to modify it manually here;
- however in some scenarios where url rewriting is involved, the default value might not work out-of-the-box
- and you can customize it via this property to suit the requirements of your application.
-
-
-
-
- Specifies the custom palettes for chart
-
-
-
-
- Chart engine
-
-
-
-
- Default chart series type
-
-
-
-
- Specifies AutoLayout mode to all items on the chart control.
-
-
-
-
- Specifies AutoLayout mode to all items on the chart control.
-
-
-
-
- Specifies the series palette
-
-
-
-
- Chart style
-
-
-
-
- Should skin override user setting or not
-
-
-
-
- Data management support object
-
-
-
-
- Collection of the chart's data series.
-
-
-
-
- Chart height
-
-
-
-
- Chart width
-
-
-
-
- Gets or sets RadChart's legend object.
-
-
-
-
- Specifies the chart's plot area.
-
-
-
-
- The chart title message.
-
-
-
-
- Enables or disables use of session.
-
-
-
-
- Enables or disables use of image maps.
-
-
-
-
- Sets folder for the chart's temp images.
-
-
-
-
- Gets or sets RadChart's content file path and file name.
-
-
-
-
- Specifies the image format in which the image is streamed.
-
-
-
-
- The alternate text displayed when the image cannot be shown.
-
-
-
-
- Specifies the custom palettes for chart
-
-
-
-
- Specifies the orientation of chart series on the plot area.
-
-
-
-
- Enables / disables Intelligent labels logic for series items labels in all plot areas.
-
-
-
-
-
- Image maps support
-
-
-
- Client-side settings.
-
-
-
-
- Gets or sets the ID of the control from which the data-bound control retrieves its list of data items.
-
-
-
-
- The DataSource object
-
- Gets or sets the object from which the chart control retrieves its list of data items
-
-
-
- Gets or sets the name of the list of data that the data-bound control binds to, in cases where the data source contains more than one distinct list of data items.
-
-
-
-
- Gets or sets the name of the DataSource column (member) that will be used to split one column data into several chart Series
-
-
-
-
- This property supports the RadChart infrastructure and is not intended for public use.
-
-
-
- RadComboBox for ASP.NET AJAX is a powerful drop-down list AJAX-based control
-
-
- The RadComboBox control supports the following features:
-
-
- Databinding that allows the control to be populated from various
- datasources
- Programmatic access to the RadComboBox object model
- which allows to dynamic creation of comboboxes, populate items, set
- properties.
- Customizable appearance through built-in or user-defined skins.
-
-
Items
-
- Each item has a Text and a Value property.
- The value of the Text property is displayed in the RadComboBox control,
- while the Value property is used to store any additional data about the item,
- such as data passed to the postback event associated with the item.
-
-
-
-
- Gets or sets the index of the selected item in the ComboBox control.
-
- Use the SelectedIndex property to programmatically specify or determine
- the index of the selected item from the combobox control
-
-
-
-
- Override in an inheritor and return false in order to skip Loading/Saving ControlState.
-
- True
-
-
-
- Raises the ItemDataBound event.
-
-
-
-
-
- Raises the ItematCreated event.
-
-
-
-
-
- Clears out the list selection and sets the Selected property
- of all items to false.
-
- Use this method to reset the control so that no items are selected.
-
-
- RadComboBox1.ClearSelection()
-
-
- RadComboBox1.ClearSelection();
-
-
-
-
-
- Signals the RadComboBox control to notify the ASP.NET application that the state of the control has changed.
-
-
-
-
- Raises the TextChanged event. This allows you to handle the event directly.
-
-
-
-
- Raises the SelectedIndexChanged event. This allows you to handle the event directly.
-
-
-
-
- Raises the ItemRequestEvent event. This allows you to handle the event directly.
-
-
-
-
- Finds the first RadComboBoxItem with Text that
- matches the given text value.
-
-
- The first RadComboBoxItem that matches the
- specified text value.
-
-
-
- Dim item As RadComboBoxItem = RadComboBox1.FindItemByText("New York")
-
-
- RadComboBoxItem item = RadComboBox1.FindItemByText("New York");
-
-
- The string to search for.
-
-
-
- Finds the first RadComboBoxItem with Text that
- matches the given text value.
-
-
- The first RadComboBoxItem that matches the
- specified text value.
-
-
-
- Dim item As RadComboBoxItem = RadComboBox1.FindItemByText("New York",true)
-
-
- RadComboBoxItem item = RadComboBox1.FindItemByText("New York",true);
-
-
- The string to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Finds the first RadComboBoxItem with Value that
- matches the given value.
-
-
- The first RadComboBoxItem that matches the
- specified value.
-
-
-
- Dim item As RadComboBoxItem = RadComboBox1.FindItemByValue("1")
-
-
- RadComboBoxItem item = RadComboBox1.FindItemByValue("1");
-
-
- The value to search for.
-
-
-
- Finds the first RadComboBoxItem with Value that
- matches the given value.
-
-
- The first RadComboBoxItem that matches the
- specified value.
-
-
-
- Dim item As RadComboBoxItem = RadComboBox1.FindItemByValue("1", true)
-
-
- RadComboBoxItem item = RadComboBox1.FindItemByValue("1", true);
-
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the index of the first RadComboBoxItem with
- Text that matches the given text value.
-
- The string to search for.
-
-
-
- Returns the index of the first RadComboBoxItem with
- Text that matches the given text value.
-
- The string to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the index of the first RadComboBoxItem with
- Value that matches the given value.
-
- The value to search for.
-
-
-
- Returns the index of the first RadComboBoxItem with
- Value that matches the given value.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the first RadComboBoxItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadComboBox1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadComboBoxItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadComboBox1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadComboBoxItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Loads combobox items from an XML content file.
-
-
-
- RadComboBox1.LoadContentFile("~/myfile.xml")
-
-
- RadComboBox1.LoadContentFile("~/myfile.xml");
-
-
- The name of the XML file.
-
-
- Sorts the items in the RadComboBox.
-
-
-
- RadComboBox1.Sort=RadComboBoxSort.Ascending
- RadComboBox1.SortItems()
-
-
- RadComboBox1.Sort=RadComboBoxSort.Ascending;
- RadComboBox1.SortItems();
-
-
-
-
- Sorts the items in the RadComboBox.
-
- An object from IComparer interface.
-
-
-
-
- RadComboBox1.Sort=RadComboBoxSort.Ascending
- Dim comparer As MyComparer = New MyComparer()
- RadComboBox1.SortItems(comparer)
- Public Class MyComparer
- Implements IComparer
-
- Public Function Compare(ByVal x As Object, ByVal y As Object) As Integer
- Dim p1 As New RadComboBoxItem()
- Dim p2 As New RadComboBoxItem()
-
- If TypeOf x Is RadComboBoxItem Then
- p1 = TryCast(x, RadComboBoxItem)
- Else
- Throw New ArgumentException("Object is not of type RadComboBoxItem.")
- End If
-
- If TypeOf y Is RadComboBoxItem Then
- p2 = TryCast(y, RadComboBoxItem)
- Else
- Throw New ArgumentException("Object is not of type RadComboBoxItem.")
- End If
-
- Dim cmp As Integer = 0
- If p1.ComboBoxParent.Sort = RadComboBoxSort.Ascending Then
- cmp = [String].Compare(p1.Value, p2.Value, Not p1.ComboBoxParent.SortCaseSensitive)
- End If
- If p1.ComboBoxParent.Sort = RadComboBoxSort.Descending Then
- cmp = [String].Compare(p1.Value, p2.Value, Not p1.ComboBoxParent.SortCaseSensitive) * -1
- End If
-
- Return cmp
- End Function
-
- End Class
-
-
-
- RadComboBox1.Sort=RadComboBoxSort.Ascending;
- MyCoparer comparer = new MyComparer();
- RadComboBox1.SortItems(comparer);
- public class MyComparer : IComparer
- {
-
- public int Compare(object x, object y)
- {
- RadComboBoxItem p1 = new RadComboBoxItem();
- RadComboBoxItem p2 = new RadComboBoxItem();
-
- if (x is RadComboBoxItem)
- p1 = x as RadComboBoxItem;
- else
- throw new ArgumentException("Object is not of type RadComboBoxItem.");
-
- if (y is RadComboBoxItem)
- p2 = y as RadComboBoxItem;
- else
- throw new ArgumentException("Object is not of type RadComboBoxItem.");
-
- int cmp = 0;
- if (p1.ComboBoxParent.Sort == RadComboBoxSort.Ascending)
- {
- cmp = String.Compare(p1.Value, p2.Value, !p1.ComboBoxParent.SortCaseSensitive);
- }
- if (p1.ComboBoxParent.Sort == RadComboBoxSort.Descending)
- {
- cmp = String.Compare(p1.Value, p2.Value, !p1.ComboBoxParent.SortCaseSensitive) * -1;
- }
-
- return cmp;
- }
-
- }
-
-
-
-
-
- Gets a list of all client-side changes (adding an item, removing an item, changing an item's property) which have occurred.
-
-
- A list of objects which represent all client-side changes the user has performed.
- By default the ClientChanges property returns empty list. Client-changes are recorded if and only if the client-side
- methods trackChanges()/commitChanges() have been invoked.
-
-
- You can use the ClientChanges property to respond to client-side modifications such as
-
- adding a new item
- removing existing item
- clearing the children of an item or the control itself
- changing a property of the item
-
- The ClientChanges property is available in the first postback (ajax) request after the client-side modifications
- have taken place. After this moment the property will return empty list.
-
-
- The following example demonstrates how to use the ClientChanges property
-
- foreach (ClientOperation<RadComboBoxItem> operation in RadToolBar1.ClientChanges)
- {
- RadComboBoxItem item = operation.Item;
-
- switch (operation.Type)
- {
- case ClientOperationType.Insert:
- //An item has been inserted - operation.Item contains the inserted item
- break;
- case ClientOperationType.Remove:
- //An item has been inserted - operation.Item contains the removed item.
- //Keep in mind the item has been removed from the combobox.
- break;
- case ClientOperationType.Update:
- UpdateClientOperation<RadComboBoxItem> update = operation as UpdateClientOperation<RadComboBoxItem>
- //The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- break;
- case ClientOperationType.Clear:
- //All children of the combobox have been removed - operation.Item will always be null.
- break;
- }
- }
-
-
- For Each operation As ClientOperation(Of RadComboBoxItem) In RadToolBar1.ClientChanges
- Dim item As RadComboBoxItem = operation.Item
- Select Case operation.Type
- Case ClientOperationType.Insert
- 'An item has been inserted - operation.Item contains the inserted item
- Exit Select
- Case ClientOperationType.Remove
- 'An item has been inserted - operation.Item contains the removed item.
- 'Keep in mind the item has been removed from the combobox.
- Exit Select
- Case ClientOperationType.Update
- Dim update As UpdateClientOperation(Of RadComboBoxItem) = TryCast(operation, UpdateClientOperation(Of RadComboBoxItem))
- 'The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- Exit Select
- Case ClientOperationType.Clear
- //All children of the combobox have been removed - operation.Item will always be Nothing.
- Exist Select
- End Select
- Next
-
-
-
-
-
- Gets a RadComboBoxItemCollection object that contains the items of the current RadComboBox control.
-
-
- A RadComboBoxItemCollection that contains the items of the current RadComboBox control. By default
- the collection is empty (RadComboBox has no children).
-
-
- Use the Items property to access the child items of RadComboBox
- You can add, remove or modify items from the Items collection.
-
-
- The following example demonstrates how to programmatically modify the properties of items.
-
- RadComboBox1.Items[0].Text = "Example";
- RadComboBox1.Items[0].Value = "1";
-
-
- RadComboBox1.Items(0).Text = "Example"
- RadComboBox1.Items(0).Value = "1"
-
-
-
-
-
- Gets or sets a value indicating whether any databinding expressions specified in the ItemTemplate should be evaluated for
- unbound items (items added inline or programmatically).
-
- true if databinding expressions should be evaluated; otherwise false; The default value is false.
-
-
-
-
- Occurs on the server when an item in the RadComboBox control is
- created.
-
-
- The ItemCreated event is raised every time a new item is
- added.
- The ItemCreated event is not related to data binding and you
- cannot retrieve the DataItem of the item in the event
- handler.
- The ItemCreated event is often useful in scenarios where you want
- to initialize all items - for example setting the ToolTip of each
- RadComboBoxItem to be equal to the Text property.
-
-
-
-
- Occurs after an item is data bound to the RadComboBox
- control.
-
-
- This event provides you with the last opportunity to access the data item
- before it is displayed on the client. After this event is raised, the data item is
- nulled out and no longer available.
-
-
-
- Occurs when the SelectedIndex property has changed.
-
- You can create an event handler for this event to determine when the selected
- index in the RadComboBox has been changed. This can be useful when
- you need to display information in other controls based on the current selection in
- the RadComboBox. You can use the event handler to load the
- information in the other controls.
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically
- occurs when the user changes the RadComboBox selection.
-
-
- Set this property to true if the server needs to capture the selection
- as soon as it is made. For example, other controls on the Web page can be
- automatically filled depending on the user's selection from a list control.
- This property can be used to allow automatic population of other controls on
- the Web page based on a user's selection from a list.
- The value of this property is stored in view state.
-
- The server-side event that is fired is
- SelectedIndexChanged.
-
-
-
-
-
- Occurs when RadComboBox initiates an AJAX callback to the
- server.
-
-
-
-
- Gets a value indicating whether the current instance of the combobox has child
- items.
-
-
-
- If RadComboBox1.IsEmpty
- '
- '
- '
- End If
-
-
- if (RadComboBox1.IsEmpty)
- {
- //
- //
- //
- }
-
-
-
-
- Sets or gets the position (left or right) of the arrow image dropdown.
-
-
- RadComboBox1.RadComboBoxImagePosition = RadComboBoxImagePosition.Left;
-
-
- RadComboBox1.RadComboBoxImagePosition = RadComboBoxImagePosition.Right
-
-
-
- By default the image is shown on the right. Left can be used in RTL
- (right-to-left) language scenarios.
-
-
-
-
- Gets or sets the text content of the RadComboBox
- control.
-
-
- In standard mode, the currently selected text can be accessed using both the
- Text property or RadCombobox.SelectedItem.Text. In
- AJAX callback modes, only the Text property can be used because
- end-users can type or paste text that does not match the text of any item and
- SelectedItem can be null.
-
-
-
- string comboText = RadComboBox1.Text
-
-
- Dim comboText As String = RadComboBox1.Text
-
-
-
-
-
- The value of the message that is shown in RadComboBox while AJAX
- callback call is in effect.
-
-
- This property can be used for customizing and localizing the text of the loading
- message.
-
-
-
-
- Gets the settings for the web service used to populate items.
-
-
- An WebServiceSettings that represents the
- web service used for populating items.
-
-
-
- Use the WebServiceSettings property to configure the web
- service used to populate items on demand.
- You must specify both
- Path and
- Method
- to fully describe the service.
-
-
- In order to use the integrated support, the web service should have the following signature:
-
-
- [ScriptService]
- public class WebServiceName : WebService
- {
- [WebMethod]
- public RadComboBoxItemData[] WebServiceMethodName(object context)
- {
- // We cannot use a dictionary as a parameter, because it is only supported by script services.
- // The context object should be cast to a dictionary at runtime.
- IDictionary<string, object> contextDictionary = (IDictionary<string, object>) context;
-
- //...
- }
- }
-
-
-
-
-
-
- Specifies the timeout after each keypress before RadComboBox
- fires an AJAX callback to the ItemsRequested server-side event.
-
-
- In miliseconds. ItemRequestTimeout = 500 is equal to half a
- second delay.
-
-
-
- The HTML Z-index of the items dropdown of RadComboBox.Its default value is 6000.
-
- Can be used when the dropdown is to be shown over content with a specified
- Z-index. If the combobox items dropdown is displayed below the content, set the
- ZIndex property to a value higher than the value of the HTML content
- below.
-
-
-
-
- Gets or sets a value that indicates whether the dropdown of the combobox should
- be opened by default on loadnig the page.
-
-
-
-
- Gets or sets a value that indicates whether the combobox autocompletion logic is
- case-sensitive or not.
-
-
-
-
- Gets or sets a value indicating whether the combobox should display the box for
- requesting additional items
-
-
-
-
- Gets or sets a value indicating whether the combobox should automatically
- autocomplete and highlight the currently typed text to the closest item text
- match.
-
-
-
-
- Gets or sets a value indicating whether the combobox should automatically
- autocomplete and highlight the currently typed text to the all items text
- match.
-
-
-
-
- Gets or sets a value indicating whether the combobox should issue a callback to
- the server whenever end-users change the text of the combo (keypress, paste,
- etc).
-
-
- In Load On Demand mode, the combobox starts a callback after a specified amount of
- time (see ItemRequestTimeout) and calls the
- server-side ItemsRequested event. Depending on the
- value of the event arguments, you can add new items to the combobox object and the
- items will be propagated to the browser after the request.
-
-
-
-
- Gets or sets a value indicating whether the combobox should cache items loaded on demand or via webservice
-
-
-
-
- Gets or sets a value indicating whether the combobox should load items on demand (via callback)
- during scrolling-down the drop-down area.
-
-
-
-
- Gets or sets a value indicating whether the text of combobox should be selected
-
-
-
-
- Gets or sets a value indicating whether the dropdown image next to the combobox
- text area should be displayed.
-
-
- The dropdown image is located in the Skins folder of the combo - by
- default ~/RadControls/ComboBox/Skins/{SkinName}/DropArrow.gif. You can
- custmoize or modify the image and place it in the respective folder of the skin you are
- using.
-
-
-
-
- Gets or sets a value indicating whether the text in a combobox item
- automatically continues on the next line when it reaches the end of the
- dropdown.
-
-
-
- Determines whether drop down should be closed on blur
-
-
- Determines whether custom text can be entered into the input field of RadComboBox.
-
-
- Determines whether the text can be entered into the input field of RadComboBox during keyboard navigation
-
-
- Determines the custom error message to be shown after the Load On Demand Callback error appears.
-
-
- Determines whether the dropdown shows when the user clicks in the input field.
-
-
- Determines whether the Screen Boundaries Detection is enabled or not.
-
-
-
- Gets or sets a value indicating whether items defined in the
- ItemTemplate template should be automatically
- highlighted on mouse hover or keyboard navigation.
-
-
-
-
- Gets or sets a list of separators: autocomplete logic is reset afer a separator
- is entered and users can autocomplete multiple items.
-
- You can use several separators at once.
-
-
- RadComboBox1.AutoCompleteSeparator = ";,";
-
-
- RadComboBox1.AutoCompleteSeparator = ";,"
-
-
-
-
- Determines whether the noscript tag containing select element to be rendered.
-
-
- Gets the currently selected item in the combobox.
-
-
- <telerik:radcombobox id="RadComboBox1" Runat="server" ></telerik:radcombobox>
-
- private void RadComboBox1_SelectedIndexChanged(object o, Telerik.WebControls.RadComboBoxSelectedIndexChangedEventArgs e)
- {
- Label1.Text = RadComboBox1.SelectedItem.Text;
- }
-
-
- <telerik:radcombobox id="RadComboBox1" Runat="server" ></telerik:radcombobox>
-
- Private Sub RadComboBox1_SelectedIndexChanged(ByVal o As Object, ByVal e As Telerik.WebControls.RadComboBoxSelectedIndexChangedEventArgs) Handles RadComboBox1.SelectedIndexChanged
- Label1.Text = RadComboBox1.SelectedItem.Text
- End Sub
-
-
-
- SelectedItem can be null in load-on-demand or
- AllowCustomText modes. End-users can type any
- text.
-
-
-
- Gets the index of the currently selected item in the combobox.
-
-
-
- Gets or sets a value indicating the horizontal offset of the combobox dropdown
-
-
- An integer specifying the horizontal offset of the combobox dropdown (measured in
- pixels). The default value is 0 (no offset).
-
-
- Use the OffsetX property to change the position of the combobox dropdown
-
- To customize the vertical offset use the OffsetY
- property.
-
-
-
-
-
- Gets or sets a value indicating the vertical offset of the combobox dropdown.
-
-
- An integer specifying the vertical offset of the combobox dropdown(measured in
- pixels). The default value is 0 (no offset).
-
-
- Use the OffsetY property to change the position where the combobox dropdown
- will appear.
-
- To customize the horizontal offset use the OffsetX
- property.
-
-
-
-
-
- Gets or sets the width of the dropdown in pixels.
-
-
-
-
- Gets or sets an additional Cascading Style Sheet (CSS) class applied to the Drop Down.
-
-
- By default the visual appearance of the Drop Down is defined in the skin CSS
- file. You can use the DropDownCssClass property to specify a CSS class
- to be applied in addition to the default CSS class.
-
-
-
-
- Gets or sets the max height of the dropdown in pixels.
-
-
-
- Gets the value of the currently selected item in the combobox.
-
-
-
- Gets or sets the template for displaying header in
- RadcomboBox.
-
-
-
-
- Gets or sets the template for displaying footer in
- RadcomboBox.
-
-
-
-
- Get a header of
- RadcomboBox.
-
-
-
-
- Get a footer of
- RadcomboBox.
-
-
-
-
- Gets or sets the template for displaying the items in
- RadcomboBox.
-
-
- A ITemplate implemented object that contains the template
- for displaying combo items. The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
- The ItemTemplate property sets a template that will be used
- for all combo items.
-
-
- The following example demonstrates how to use the
- ItemTemplate property to add a CheckBox for each item.
- ASPX:
- <telerik:RadComboBox runat="server" ID="RadComboBox1">
-
- </telerik:RadComboBox>
-
-
-
- Gets or sets the maximum number of characters allowed in the combobox.
-
-
-
- Indicates whether the combobox will be visible while loading.
-
-
-
- Gets the settings for the animation played when the dropdown opens.
-
- An AnnimationSettings that represents the
- expand animation.
-
-
-
- Use the ExpandAnimation property to customize the expand
- animation of RadComboBox. You can specify the
- Type,
- Duration and the
- To disable expand animation effects you should set the
- Type to
- AnimationType.None.
- To customize the collapse animation you can use the
- CollapseAnimation property.
-
-
-
- The following example demonstrates how to set the ExpandAnimation
- of RadComboBox.
-
- ASPX:
-
-
- <telerik:RadComboBox ID="RadComboBox1" runat="server">
- <ExpandAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadComboBoxItem Text="News" >
- </telerik:RadComboBoxItem>
- </Items>
-
-
- </telerik:RadComboBox>
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadComboBox1.ExpandAnimation.Type = AnimationType.Linear;
- RadComboBox1.ExpandAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadComboBox1.ExpandAnimation.Type = AnimationType.Linear
- RadComboBox1.ExpandAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the timeout after which a dropdown starts to
- open.
-
-
- An integer specifying the timeout measured in milliseconds. The default value is
- 100 milliseconds.
-
-
- Use the ExpandDelay property to delay dropdown opening.
-
- To customize the timeout prior to item closing use the
- CollapseDelay property.
-
-
-
- The following example demonstrates how to specify a half second (500
- milliseconds) timeout prior to dropdown opening:
- ASPX:
- <telerik:RadComboBox ID="RadComboBox1" runat="server"
- ExpandDelay="500" />
-
-
-
- Gets the settings for the animation played when an item closes.
-
- An AnnimationSettings that represents the
- collapse animation.
-
-
-
- Use the CollapseAnimation property to customize the collapse
- animation of RadComboBox. You can specify the
- Type,
- Duration and the
- items are collapsed.
- To disable collapse animation effects you should set the
- Type to
- AnimationType.None. To customize the expand animation you can
- use the CollapseAnimation property.
-
-
-
- The following example demonstrates how to set the
- CollapseAnimation of RadComboBox.
-
- ASPX:
-
-
- <telerik:RadComboBox ID="RadComboBox1" runat="server">
- <CollapseAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadComboBoxItem Text="News" >
- </telerik:RadComboBoxItem>
- </Items>
-
-
- </telerik:RadComboBox>
-
-
-
-
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadComboBox1.CollapseAnimation.Type = AnimationType.Linear;
- RadComboBox1.CollapseAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadComboBox1.CollapseAnimation.Type = AnimationType.Linear
- RadComboBox1.CollapseAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the timeout after which a dropdown starts to
- close.
-
-
- An integer specifying the timeout measured in milliseconds. The default value is
- 500 (half a second).
-
-
- Use the CollapseDelay property to delay dropdown closing. To
- cause immediate item closing set this property to 0 (zero).
-
- To customize the timeout prior to item closing use the
- ExpandDelay property.
-
-
-
- The following example demonstrates how to specify one second (1000
- milliseconds) timeout prior to dropdown closing:
- ASPX:
- <telerik:RadComboBox ID="RadComboBox1" runat="server"
- ClosingDelay="1000" />
-
-
-
-
- Automatically sorts items alphabetically (based on the Text
- property) in ascending or descending order.
-
-
-
- RadComboBox1.Sort = RadComboBoxSort.Ascending;
- RadComboBox1.Sort = RadComboBoxSort.Descending;
- RadComboBox1.Sort = RadComboBoxSort.None;
-
-
- RadComboBox1.Sort = RadComboBoxSort.Ascending
- RadComboBox1.Sort = RadComboBoxSort.Descending
- RadComboBox1.Sort = RadComboBoxSort.None
-
-
-
-
-
- Gets/sets whether the sorting will be case-sensitive or not.
- By default is set to true.
-
-
-
- RadComboBox1.SortCaseSensitive = false;
-
-
-
- RadComboBox1.SortCaseSensitive = false
-
-
-
-
-
- Occurs when the text of the RadComboBox changes between postbacks to the server.
-
-
-
-
- The client-side event that is fired when the selected index of the
- RadComboBox is about to be changed.
-
-
-
- The event handler receives two parameters: the instance of of the RadComboBox
- client-side object and event argument of the newly selected item.
-
-
- The event can be cancelled - simply call
- args.set_cancel(true);
- from the event handler and the item will not be changed.
-
-
-
-
- <script type="text/javascript">
- function onSelectedIndexChanging(sender, eventArgs)
- {
- var item = eventArgs.get_item();
- if (item.get_text() == "LA")
- {
- // do not allow selecting item with text "LA"
- return false;
- }
- else
- {
- // alert the new item text and value.
- alert(item.get_text() + ":" + item.get_value());
- }
- }
- </script>
-
- <telerik:radcombobox ID="RadComboBox1" runat="server"
- OnClientSelectedIndexChanging="onSelectedIndexChanging">
- </telerik:radcombobox>
-
-
-
-
-
- The client-side event that is fired after the selected index of the RadComboBox has
- been changed.
-
-
- The event handler receives two parameters: the instance of of the combobox
- client-side object and event argument with the newly selected item.
-
-
-
- <script language="javascript">
- function onSelectedIndexChanged(sender,eventArgs)
- {
- var item = eventArgs.get_item();
- // alert the new item text and value.
- alert(item.get_text() + ":" + item.get_value());
- }
- </script>
-
- <telerik:radcombobox ID="RadComboBox1" runat="server"
- OnClientSelectedIndexChanged="onSelectedIndexChanged">
- </telerik:radcombobox>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadComboBox is about to be populated (for example from web service).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onItemRequestingHandler(sender, eventArgs)
- {
- var context = eventArgs.get_context();
- context["Parameter1"] = "Value";
- }
- </script>
- <telerik:RadComboBox ID="RadComboBox1"
- runat="server"
- OnClientItemPopulating="onClientItemPopulatingHandler">
- ....
- </telerik:RadComboBox>
-
-
- If specified, the OnClientItemsRequesting client-side event
- handler is called when the RadComboBox is about to be populated.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with three properties:
-
- get_context(), an user object that will be passed to the web service.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadComboBox items were just populated (for example from web service).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onItemsRequested(sender, eventArgs)
- {
- alert("Loading finished");
- }
- </script>
- <telerik:RadComboBox ID="RadComboBox1"
- runat="server"
- OnClientItemsRequested="onItemsRequested">
- ....
- </telerik:RadComboBox>
-
-
- If specified, the OnClientItemsRequested client-side event
- handler is called when the RadComboBox items were just populated.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs, null for this event.
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the operation for populating the RadComboBox has failed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onItemsRequestFailed(sender, eventArgs)
- {
- alert("Error: " + errorMessage);
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadComboBox ID="RadComboBox1"
- runat="server"
- OnClientItemsRequestFailed="onItemsRequestFailed">
- ....
- </telerik:RadComboBox>
-
-
- If specified, the OnClientItemsRequestFailed client-side event
- handler is called when the operation for populating the RadComboBox has failed.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with one property:
-
- set_cancel(), set to true to suppress the default action (alert message).
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets the name of the JavaScript function called when an Item is created during Web Service Load on Demand.
-
-
-
-
- The client-side event that is fired when the user presses a key inside the
- combobox.
-
-
-
- <telerik:radcombobox
- Runat="server"
- ID="RadComboBox3"
- OnClientKeyPressing="HandleKeyPress"
- ...
- />
-
- <script type="text/javascript">
-
- function HandleKeyPress(sender, e)
- {
- if (e.keyCode == 13)
- {
- document.forms[0].submit();
- }
- }
-
- </script>
-
-
-
- The event handler receives two parameters:
-
- the instance of the combobox client-side object;
- browser event arguments.
-
- You can use the browser event arguments (and the keyCode
- property in particular) to detect which key was pressed and to write your own
- custom logic.
-
-
-
-
- The client-side event that is fired before the dropdown of the combobox is
- opened.
-
-
-
- <script language="javascript">
-
- function HandleOpen(sender,args)
- {
- if (someCondition)
- {
- args.set_cancel(true);
- }
- else
- {
- alert("Opening combobox with " + comboBox.get_items().get_count() + " items");
- }
- }
-
- </script>
-
-
- <telerik:radcombobox
- id="RadComboBox1"
- Runat="server"
- OnClientDropDownOpening="HandleOpen">
- </telerik:radcombobox>
-
-
-
- The event handler receives two parameter: the instance of the combobox
- client-side object and event args. The event can be cancelled - simply set args.set_cancel to true args.set_cancel(true);
- from the event handler and the combobox dropdown will not be opened.
-
-
-
-
- The client-side event that is fired after the dropdown of the combobox is
- opened.
-
-
-
- <script language="javascript">
-
- function HandleOpen(sender,args)
- {
- alert("Opening combobox with " + comboBox.get_items().get_count() + " items");
-
- }
-
- </script>
-
-
- <telerik:radcombobox
- id="RadComboBox1"
- Runat="server"
- OnClientDropDownOpened="HandleOpen">
- </telerik:radcombobox>
-
-
-
- The event handler receives two parameter: the instance of the combobox
- client-side object and event args. The event cannot be cancelled.
-
-
-
-
- The client-side event that is fired when when the combo gains focus
-
-
-
- <script type="text/avascript">
-
- function OnClientFocus(sender,args)
- {
- alert("focus");
- }
-
- </script>
-
-
- <telerik:radcombobox
- id="RadComboBox1"
- Runat="server"
- OnClientFocus="OnClientFocus">
- </telerik:radcombobox>
-
-
-
- The event handler receives two parameter: the instance of the combobox
- client-side object and event args.
-
-
-
-
- The client-side event that is fired when when the combo loses focus
-
-
-
- <script type="text/avascript">
-
- function OnClientBlur(sender,args)
- {
- alert("blur");
- }
-
- </script>
-
-
- <telerik:radcombobox
- id="RadComboBox1"
- Runat="server"
- OnClientBlur="OnClientBlur">
- </telerik:radcombobox>
-
-
-
- The event handler receives two parameter: the instance of the combobox
- client-side object and event args.
-
-
-
-
- The client-side event that is fired before the dropdown of the combobox is
- closed.
-
-
- The event handler receives two parameter: the instance of the combobox
- client-side object and event args. The event can be cancelled - simply set args.set_cancel to true args.set_cancel(true);
- from the event handler and the combobox dropdown will not be closed.
-
-
-
- <script language="javascript">
-
- function HandleClose(sender, args)
- {
- if (someCondition)
- {
- args.set_cancel(true);
- }
- else
- {
- alert("Closing combobox with " + sender.get_items().get_count() + " items");
- }
- }
-
- </script>
-
-
- <telerik:radcombobox
- id="RadComboBox1"
- Runat="server"
- OnClientDropDownClosing="HandleClose">
- </telerik:radcombobox>
-
-
-
-
-
- The client-side event that is fired after the dropdown of the combobox is
- closed.
-
-
- The event handler receives two parameter: the instance of the combobox
- client-side object and event args. The event can not be cancelled
-
-
-
- <script language="javascript">
-
- function HandleClose(sender, args)
- {
- alert("Closed combobox with " + sender.get_items().get_count() + " items");
-
- }
-
- </script>
-
-
- <telerik:radcombobox
- id="RadComboBox1"
- Runat="server"
- OnClientDropDownClosed="HandleClose">
- </telerik:radcombobox>
-
-
-
-
-
- If specified, the OnClienLoad client-side event handler is
- called after the combobox is fully initialized on the client.
- A single parameter - the combobox client object - is passed to the
- handler.
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function onClientLoadHandler(sender)
- {
- alert(sender.get_id());
- }
- </script>
- <telerik:RadComboBox ID="RadComboBox1"
- runat= "server"
- OnClientLoad="onClientLoadHandler">
- ....
- </telerik:RadComboBox>
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after the RadComboBox client-side object is initialized.
-
-
-
-
- RadComboBoxItem class.
-
-
-
-
- Returns true if the control is rendered by the ControlItem itself;
- false if it was added by the user to the Controls collection.
-
-
-
-
-
-
-
-
-
-
-
-
- The ID property is reserved for internal use. Please use the Value property or
- use the Attributes collection if you need to assign
- custom data to the item.
-
-
-
-
- Gets the zero based index of the item.
-
-
-
-
- Gets or sets the access key that allows you to quickly navigate to the Web server control.
-
-
- The access key for quick navigation to the Web server control.
- The default value is String.Empty, which indicates that this property is not set.
-
-
- The specified access key is neither null, String.Empty nor a single character string.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- Initializes a new instance of the class.
- Does not set the Value property of the instance.
-
- The text of the item.
-
-
-
- Initializes a new instance of the class.
-
- The text of the item.
- The value of the item.
-
-
-
- Compares two instance for equality.
- returns 0 if equal, a positive number if the first is greater than the
- second, and a negative number otherwise.
-
-
-
-
-
- Gets or sets the text caption for the combobox item.
- The text of the item. The default value is empty string.
-
- Use the Text property to specify the text to display for the
- item.
-
-
-
- Gets or sets the value for the combobox item.
- The value of the item. The default value is empty string.
-
- Use the Value property to specify the value
-
-
-
-
- Gets the RadComboBox instance which contains the current item.
-
-
-
-
- Gets the RadComboBox instance which contains the current item.
-
-
-
- Gets or sets the selected state of the combobox item.
- The default value is true.
-
- Use the Selected property to determine whether the item is selected or not.
-
-
-
- Gets or sets the tooltip of the combobox item.
-
-
-
- Sets or gets whether the item is separator. It also represents a logical state of
- the item. Might be used in some applications for keyboard navigation to omit processing
- items that are marked as separators.
-
-
-
- Gets or sets the path to an image to display for the item.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the ImageUrl property to specify the image for the item. If
- the ImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
- Gets or sets the path to an image to display for the item when it is disabled.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the DisabledImageUrl property to specify the image for the item when it is disabled. If
- the DisabledImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
-
- A collection of RadComboBoxItem objects in a
- RadComboBox control.
-
-
- The RadComboBoxItemCollection class represents a collection of
- RadComboBoxItem objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadComboBoxItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of combo items in the collection.
-
-
- Use the Add method to add items in the collection.
-
-
- Use the Remove method to remove items from the
- collection.
-
-
-
-
-
-
-
- Initializes a new instance of the RadComboBoxItemCollection class.
-
- The owner of the collection.
-
-
-
- Appends the specified RadComboBoxItem object to the end of the current RadComboBoxItemCollection.
-
-
- The RadComboBoxItem to append to the end of the current RadComboBoxItemCollection.
-
-
- The following example demonstrates how to programmatically add items in a
- RadComboBox control.
-
- RadComboBoxItem newsItem = new RadComboBoxItem("News");
- RadComboBox1.Items.Add(newsItem);
-
-
- Dim newsItem As RadPanelItem = New RadComboBoxItem("News")
- RadComboBox1.Items.Add(newsItem)
-
-
-
-
-
- Finds the first RadComboBoxItem with Text that
- matches the given text value.
-
-
- The first RadComboBoxItem that matches the
- specified text value.
-
- The string to search for.
- This method is not recursive.
-
-
-
- Finds the first RadComboBoxItem with Value that
- matches the given value.
-
-
- The first RadComboBoxItem that matches the
- specified value.
-
- The value to search for.
- This methos is not recursive.
-
-
-
- Searches the items in the collection for a RadComboBoxItem which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadComboBoxItem that matches the specified arguments. Null (Nothing) is returned if no node is found.
- This method is not recursive.
-
-
-
- Finds the first RadComboBoxItem with Text that
- matches the given text value.
-
-
- The first RadComboBoxItem that matches the
- specified text value.
-
-
-
- Dim item As RadComboBoxItem = RadComboBox1.FindItemByText("New York",true)
-
-
- RadComboBoxItem item = RadComboBox1.FindItemByText("New York",true);
-
-
- The string to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Finds the first RadComboBoxItem with Value that
- matches the given value.
-
-
- The first RadComboBoxItem that matches the
- specified value.
-
-
-
- Dim item As RadComboBoxItem = RadComboBox1.FindItemByValue("1", true)
-
-
- RadComboBoxItem item = RadComboBox1.FindItemByValue("1", true);
-
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the index of the first RadComboBoxItem with
- Text that matches the given text value.
-
- The string to search for.
-
-
-
- Returns the index of the first RadComboBoxItem with
- Text that matches the given text value.
-
- The string to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the index of the first RadComboBoxItem with
- Value that matches the given value.
-
- The value to search for.
-
-
-
- Returns the index of the first RadComboBoxItem with
- Value that matches the given value.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the first RadComboBoxItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadComboBox1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadComboBoxItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadComboBox1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadComboBoxItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Determines whether the specified RadComboBoxItem object is in the current
- RadComboBoxItemCollection.
-
-
- The RadComboBoxItem object to find.
-
-
- true if the current collection contains the specified RadComboBoxItem object;
- otherwise, false.
-
-
-
- Appends the specified array of RadComboBoxItem objects to the end of the
- current RadComboBoxItemCollection.
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple items in a single step.
-
- RadComboBoxItem[] items = new RadComboBoxItem[] { new RadComboBoxItem("First"), new RadComboBoxItem("Second"), new RadComboBoxItem("Third") };
- RadComboBox1.Items.AddRange(items);
-
-
- Dim items() As RadComboBoxItem = {New RadComboBoxItem("First"), New RadComboBoxItem("Second"), New RadComboBoxItem("Third")}
- RadComboBox1.Items.AddRange(items)
-
-
-
- The array of RadComboBoxItem o append to the end of the current
- RadComboBoxItemCollection.
-
-
-
-
- Determines the index of the specified RadComboBoxItem object in the collection.
-
-
- The RadComboBoxItem to locate.
-
-
- The zero-based index of item within the current RadComboBoxItemCollection,
- if found; otherwise, -1.
-
-
-
-
- Inserts the specified RadComboBoxItem object in the current
- RadComboBoxItemCollection at the specified index location.
-
- The zero-based index location at which to insert the RadComboBoxItem.
- The RadComboBoxItem to insert.
-
-
-
- Removes the specified RadComboBoxItem object from the current
- RadComboBoxItemCollection.
-
-
- The RadComboBoxItem object to remove.
-
-
-
-
- Removes the specified RadComboBoxItem object from the current
- RadComboBoxItemCollection.
-
-
- The zero-based index of the index to remove.
-
-
-
-
- Sort the items from RadComboBoxItemCollection.
-
-
-
-
- Sort the items from RadComboBoxItemCollection.
-
-
- An object from IComparer interface.
-
-
-
-
- A collection of RadComboBoxItem objects in a
- RadComboBox control.
-
-
- The RadComboBoxItemCollection class represents a collection of
- RadComboBoxItem objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadComboBoxItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of combo items in the collection.
-
-
- Use the Add method to add items in the collection.
-
-
- Use the Remove method to remove items from the
- collection.
-
-
-
-
-
-
-
- A collection of RadComboBoxItem objects in a
- RadComboBox control.
-
-
- The RadComboBoxItemCollection class represents a collection of
- RadComboBoxItem objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadComboBoxItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of combo items in the collection.
-
-
- Use the Add method to add items in the collection.
-
-
- Use the Remove method to remove items from the
- collection.
-
-
-
-
-
-
-
- Gets the RadComboBoxItem object at the specified index in
- the current RadComboBoxItemCollection.
-
-
- The zero-based index of the RadComboBoxItem to retrieve.
-
-
- The RadComboBoxItem at the specified index in the
- current RadComboBoxItemCollection.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Clientside implementation of visual element resize functionality
-
-
-
-
-
-
-
-
- Clientside implementation of visual element resize functionality
-
-
-
-
- This class is intended to simply define the common scripts reference
-
-
-
-
- Used from DialogLoaderBase to extract the definition
- of the dialog to be loaded
-
-
- The parameters got from the DialogLoader. They must include
- either VirtualPath or Type for the control to be loaded.
-
-
-
-
- Used from a RadControl (Editor, Spell) to define an UserControl dialog
-
- The path to the ascx to be loaded
- The parameters to be passed to the dialog
-
-
-
- Used from a RadControl (Editor, Spell) to define a WebControl dialog
-
- The type of the control to be loaded
- The parameters to be passed to the dialog
-
-
-
- Gets or sets a value indicating the behavior of this dialog - if it can be
- resized, has expand/collapse commands, closed command, etc.
-
-
-
-
- This is the default dialog handler class for Telerik dialogs. It requires Session State to be enabled
-
-
-
-
- This class can be used instead of the default (DialogHandler) class for Telerik dialogs. It does not require Session State to be enabled.
-
-
-
-
- RadDialogOpener class
-
-
-
-
-
-
-
-
- This control has no skin! This property will prevent the SkinRegistrar from
- registering the missing CSS references.
-
-
-
-
- A read-only property that returns the RadWindow instance used in the RadDialogOpener control.
-
-
-
-
- Gets or sets an additional querystring appended to the dialog URL.
-
- A String, appended to the dialog URL
- TODO
-
-
-
- Gets the DialogDefinitionDictionary, containing the DialogDefinitions of the managed dialogs.
-
- TODO
- TODO
-
-
-
- Gets or sets a value, indicating if classic windows will be used for opening a dialog.
-
- A boolean, indicating if classic windows will be used
- for opening a dialog
- When set to true, the RadDialogOpener shows a dialog similar to the
- ones opened by window.open and window.showModalDialog;
-
-
- Gets or sets the localization language for the user interface.
-
- The localization language for the user interface. The default value is
- en-US.
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded scripts or not.
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed script files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
-
- Gets or sets the client-side script that gets executed when the dialog opening event is raised
-
-
-
-
- Gets or sets the client-side script that gets executed when the dialog closing event is raised
-
-
-
-
- Gets or sets the location of a CSS file, that will be added in the dialog window. If you need to include
- more than one file, use the CSS @import url(); rule to add the other files from the first.
- This property is needed if you are using a custom skin. It allows you to include your custom skin
- CSS in the dialogs, which are separate from the main page.
-
-
-
-
- Gets or sets the location of a JavaScript file, that will be added in the dialog window. If you need to include
- more than one file, you will need to combine the scripts into one first.
- This property is needed if want to override some of the default functionality without loading the dialog
- from an external ascx file.
-
-
-
-
- Get/Set the animation effect of the window
-
-
-
-
- This class is provided for backwards compatibility with old solutions.
-
-
-
-
- An empty class to just indicate that the parameters must be taken in a querystring/javascript manner
-
-
-
-
- Instantiates the DialogParametersProvider
-
- The page that uses the DialogParametersProvider
-
-
-
- Returns the DialogParameters for a dialog
-
- the unique identifier of the dialogOpener, which
- parameters are stored
- the name of the dialog which parameters are requested
- the DialogParameters for the specified dialog of the exact editor
-
-
-
- Stores the DialogParameters for
- all the dialogs of a specified RadDialogOpener
-
- the unique identifier of the editor
- which DialogParameters
- will be stored
- The list of dialog parameters
-
-
-
- DialogParametersSerializer - serializes a DialogParameters object to a string and deserializes it.
-
-
- Known limitations:
-
- When deserializing, the enum values are passed as ints and an implicit cast is required.
- If a string array with a one element == string.Empty is passed, the deserialized array will have no elements
-
-
-
-
-
-
- Defines the RadDock titlebar and grips behavior.
-
-
-
-
- The control will not have titlebar or grips.
-
-
-
-
- The control will have only titlebar.
-
-
-
-
- The control will have only grips.
-
-
-
-
- Provides data for the SaveDockLayout and the LoadDockLayout events.
-
-
-
-
- Initializes a new instance of the DockLayoutEventArgs class
-
-
-
-
- Dictionary, containing UniqueName/DockZoneID pairs.
-
-
-
-
- Dictionary, containing UniqueName/Index pairs.
-
-
-
-
- Represents the method that handles a SaveDockLayout or LoadDockLayout events
-
- The source of the event
- A DockLayoutEventArgs that contains the event data
-
-
-
- Defines the docking behavior of a RadDock control
-
-
-
-
- The RadDock control is able to float (to be undocked)
-
-
-
-
- The RadDock control is able to dock into zones
-
-
-
-
- The RadDock control is able to be both docked and undocked.
-
-
-
-
- Represents the PinUnpin command item in a RadDock control.
-
-
-
-
- Initializes a new instance of the DockPinUnpinCommand class
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Defines the commands which should appear in the RadDock control
- titlebar when its Commands property is not set.
-
-
-
-
- No commands will appear
-
-
-
-
- Close command
-
-
-
-
- ExpandCollapse command
-
-
-
-
- PinUnpin command
-
-
-
-
- All commands
-
-
-
-
- Provides data for the DockPositionChanged event.
-
-
-
-
- Contains the ClientID of the dock zone the dock has been dropped to.
- If the dock was not dropped in a zone (undocked) the value will be
- string.Empty.
-
-
-
-
- Contains the index of the dock in the new dock zone
-
-
-
-
- Represents the method that handles a DockPositionChanged event
-
- The source of the event
- A DockPositionChangedEventArgs that contains the event data
-
-
-
- Defines the state of a DockToggleCommand item
-
-
-
-
- The command is in primary state. It will be initially rendered
- using the CssClass and Text properties.
-
-
-
-
- The command is in alternate state. It will be initially rendered
- using the AlternateCssClass and AlternateText properties.
-
-
-
-
- Use this attribute to set the width of a DropDown
-
-
-
-
- Use this attribute to set the height of a DropDown
-
-
-
-
- Use this attribute to set the popup class name of a DropDown
-
-
-
-
- Use this attribute to let the DropDown to adjust its size to its content automatically
-
-
-
-
- Use this attribute to set the number of the items per row in a DropDown
-
-
-
-
- Copied from Reflector
-
-
-
-
- This control has no skin! This property will prevent the SkinRegistrar from
- registering the missing CSS references.
-
-
-
-
- Gets or sets a string containing the localization language for the RadEditor UI
-
-
-
-
- Gets or sets a value indicating where the editor will look for its dialogs.
-
-
- A relative path to the dialogs location. For example: "~/controls/RadEditorDialogs/".
-
-
- If specified, the ExternalDialogsPath
- property will allow you to customize and load the editor dialogs from normal ASCX files.
-
-
-
-
- Gets or sets a value indicating where the control will look for its .resx localization files.
- By default these files should be in the App_GlobalResources folder. However, if you cannot put
- the resource files in the default location or .resx files compilation is disabled for some reason
- (e.g. in a DotNetNuke environment), this property should be set to the location of the resource files.
-
-
- A relative path to the dialogs location. For example: "~/controls/RadEditorResources/".
-
-
- If specified, the LocalizationPath
- property will allow you to load the control localization files from any location in the
- web application.
-
-
-
-
- Represents a CssFile item.
-
-
-
-
- A strongly typed collection of EditorCssFile objects
-
-
-
-
-
-
-
- This property sets the tool name in the client script.
-
-
-
-
- This property instructs the tool to attach its own click handlers and not to rely on a tool adapter
-
-
-
-
- Encapsulates the properties used for FileBrowser dialog management.
-
-
- The FileManagerDialogConfiguration members are passed in a secure manner to
- the respective dialogs using the DialogParameters
- collection of the editor.
-
-
-
-
- Gets or sets the view paths of the FileManager dialog.
-
-
- A String array, containing virtual paths which subfolders and files
- the FileManager dialog will search and display. The default value is an empty String array.
-
-
-
-
- Gets or sets the upload paths of the FileManager dialog.
-
-
- A String array, containing virtual paths to which files
- can be uploaded or subfolders can be created. The default value is an empty String array.
-
-
- As only files/folders, contained in the ViewPaths
- array will be displayed, users are able to upload files/create subfolders only
- to folders, belonging to the intersection of the ViewPaths and
- UploadPaths properties.
-
-
-
-
- Gets or sets the delete paths of the FileManager dialog.
-
-
- A String array, containing virtual paths in which files or
- subdirectories can be deleted. The default value is an empty String array.
-
-
- As only files/folders, contained in the ViewPaths
- array will be displayed, users are able to delete only the files/folders,
- belonging to the intersection of the ViewPaths and
- UploadPaths properties.
-
-
-
-
- Gets or sets the extension patterns for files to be displayed in the FileManager dialog.
-
-
- A String array, containing extension patterns for
- files to be displayed in the FileManager dialog.
-
-
- Values can contain wildcars (e.g. *.*, *.j?g)
-
-
-
-
- Gets or sets the max filesize which users are able to upload in bytes
-
-
- An Int32, representing the max filesize which users are able
- to upload in bytes.
-
-
- The value of the MaxUploadFileSize property should be less or equal
- to the <httpRuntime maxRequestLength...> website property, specified in either
- the web.config or machine.config files. The <httpRuntime maxRequestLength...>
- property controls the allowed post request length for the website.
-
-
-
-
- Gets or sets the fully qualified type name of the FileBrowserContentProvider used in the dialog,
- including the assembly name, version, culture, public key token.
-
-
- The default value is string.Empty
-
-
- When the value of this property is string.Empty (default), the dialog will use the integrated
- FileSystemContentProvider.
-
-
-
-
- This property gets the current content provider type. To set the content provider type use ContentProviderTypeName
-
-
- If no provider is set, this property will return the default FileSystemContentProvider
-
-
-
-
- A RadEditor color picker color
-
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- A strongly typed collection of EditorColor objects
-
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- Adds a EditorColor object, initialized with the specified value.
-
-
-
-
- When overridden in a derived class, instructs an object contained by the collection to record its entire state to view state, rather than recording only change information.
-
- The that should serialize itself completely.
-
-
-
- Represents a RadEditor context menu.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the name of the tag, this EditorContextMenu will be associated to.
-
-
-
-
- Gets or sets a value indicating whether this is enabled.
-
- true if enabled; otherwise, false.
-
-
-
- Gets the collection of EditorTool objects, placed in this context menu instance.
-
-
-
-
- A strongly typed collection of EditorContextMenu objects
-
-
-
-
- Adds the specified item to the collection. If the collection already contains an item
- with the same TagName, it will be replaced with the new item.
-
-
-
-
-
-
-
-
- Represents a CssClass dropdown item.
-
-
-
-
- A strongly typed collection of EditorCssClass objects
-
-
-
-
- Represents a FontName dropdown item.
-
-
-
-
- A strongly typed collection of EditorFont objects
-
-
-
-
- Represents a FontSize dropdown item.
-
-
-
-
- A strongly typed collection of EditorFontSize objects
-
-
-
-
- A strongly typed collection of EditorLink objects
-
-
-
-
- Represents a FormatBlock dropdown item.
-
-
-
-
- The tag which the selected text will be enclosed with.
-
-
-
-
- The text which will be displayed in the FormatBlock dropdown
-
-
-
-
- A strongly typed collection of EditorParagraph objects
-
-
-
-
- Represents a RealFontSize dropdown item.
-
-
-
-
- A strongly typed collection of EditorRealFontSize objects
-
-
-
-
- Represents a InsertSnippet dropdown item.
-
-
-
-
- A strongly typed collection of EditorSnippet objects
-
-
-
-
- Represents a InsertSymbol dropdown item.
-
-
-
-
- A strongly typed collection of EditorSymbol objects
-
-
-
-
- Represents a SpellCheck dropdown item.
-
-
-
-
- A strongly typed collection of SpellCheckerLanguage objects
-
-
-
-
- A special EditorTool object, which is rendered as a separator by the default
- ToolAdapter.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets a value indicating whether this is visible.
-
- true if visible; otherwise, false.
-
-
-
- Gets the custom attributes which will be serialized on the client.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the type of the tool - by default it is a button
-
- The type of the tool on the client.
-
-
-
-
-
-
-
- Adds the specified item.
-
- The item.
-
-
-
- Determines whether the collection contains the specified item.
-
- The item.
-
- true if the collection contains the specified item; otherwise, false.
-
-
-
-
- Copies the collection items to the specified array.
-
-
-
-
- Adds the specified items to the collection.
-
-
-
-
- Gets the index of the specified item.
-
-
-
-
- Inserts the specified item at the specified index.
-
-
-
-
- Removes the specified item.
-
-
-
-
- Removes the item at the specified index.
-
- The zero-based index of the item to remove.
- index is not a valid index in the .
- The is read-only.-or- The has a fixed size.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the tool at the specified index.
-
-
-
-
-
-
-
-
- Represents a ToolStrip RadEditor tool, containing other tools.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the name of the tool strip.
-
- The name.
-
-
-
- Gets the collection of EditorTool objects, inside the tool strip.
-
- The tools.
-
-
-
- Encapsulates the properties used for ImageManager dialog management.
-
-
-
-
- Gets or sets the default suffix for thumbnails.
-
-
- A String, specifying the default thumbnail suffix. The default value
- is "thumb".
-
-
- Used in the ImageManager dialog. The value of the ImageEditorFileSuffix property is
- used to determine if an image selected in the file browser is a thumbnail of another image
- in the same folder. When a thumbnail image is selected in the file list, additional controls
- for the image insertion appear - if the inserted image should link to the original one and
- if the link that will be inserted will open in a new window.
-
-
-
-
- Gets or sets a value indicating whether to show the Image Editor tool in the Image Manager dialog.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets the custom attributes which will be serialized on the client.
-
-
-
- Gets or sets the suffix for the custom dictionary files.
- The default is -Custom
-
- The filenames are formed with the following scheme: Language + CustomDictionarySuffix +
- ".txt". Different suffixes can be used to create different custom dictionaries for
- different users.
-
-
-
- Gets or sets the path for the dictionary files.
- The default is ~/App_Data/Spell/
-
- This is the path that contains the TDF files, and the custom dictionary TXT
- files.
-
-
-
-
- Gets or sets a the edit distance. If you increase the value, the checking speed
- decreases but more suggestions are presented. Applicable only in EditDistance mode.
-
- The default is 1
-
- This property takes effect only if the
- SpellCheckProvider property is set to
- EditDistanceProvider.
-
-
-
- Gets or sets the value indicating whether the spell will allow adding custom words.
- The default is true
-
-
-
- Gets or sets the spellcheck language if different than the Language property.
-
-
-
-
- Configures the spellchecker engine, so that it knows whether to skip URL's, email
- addresses, and filenames and not flag them as erros.
-
-
-
-
- Specifies the type name for a custom spell check provider.
-
-
-
-
- Specifies the spellchecking algorithm that will be used.
-
-
- The default is TelerikProvider
-
-
-
-
- Gets or sets the value used to configure the spellchecker engine to ignore words containing: UPPERCASE, some
- CaPitaL letters, numbers; or to ignore repeated words (very very)
-
-
-
-
- Gets or sets the URL, to which the spellchecker engine AJAX call will be made. Check the help for more information.
-
-
-
-
- Gets or sets the type for the spell custom dictionary provider.
-
-
-
-
- This property gets or sets a value, indicating whether to show the input box of the spin box element
-
-
-
-
- Parses the ToolsFileContent property of RadEditor and initializes the corresponding
- collections.
-
-
-
-
- Initializes the Colors collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the ContextMenus collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the CssClasses collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the CssFiles collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Links collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Links collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Languages collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Links collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Modules collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Paragraphs collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Links collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Snippets collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Symbols collection from the ToolsFileContent property of RadEditor.
-
-
-
-
- Initializes the Tools collection from the ToolsFileContent property of RadEditor.
-
-
-
- This is a base class for all column editors for GridCheckBoxColumn.
- It defines the base properties for controls that can edit boolean values.
-
-
-
- Interface that describes the baseic column editor functionality, needed for a
- class that should be responsible for editing of a content of a cell in a
-
-
-
- Implement column editor to provide extended editing functionality in RadGrid. The column-editor inheritors should provide the methods for
- creating the column editor control inside the container (generally a grid TableCell). For example the default column editor for GridBoundColumn
- creates a TextBox control and adds it to the corresponding GridtableCell when the InstantiateInControl method is called.
- To inherit the base implementation of a column editor control in RadGrid you may consider deriving from instead implementing the IColumnEditor interface.
-
-
-
-
- Implement this member to add control int the given container.
- After the call to this method the ContainerControl property should return the instance of containerControl parameter passed to this function.
-
-
-
-
-
- The editor should recreate its state and imput controls from the Container.
-
- control (generally a TableCell) that contains the input controls, previously instantiated within the InitializeInControl method call
-
-
-
- Gets the instance of the Container control (generally a TableCell), after the last call of InstantiateInControl method
-
-
-
-
- Get value if the editor has been initialized after an InitializeInControl or InitializeFromControl method call
-
-
-
-
- Get a value indicating if the column/row the editor currently is instantiated is in edit mode.
-
-
-
-
- Copy setting from given column editor
-
-
-
-
-
- Create the input/edit controls belonging to the editor and prepare for AddControlsToContainer call.
-
-
-
-
- Implement this member to create the edit controls in the grid cell.
- This method is called from each column's InitializeCell method, when a initializes its cells.
-
-
-
-
- This method should recrteate the state of the column editor (edit controls, etc) from the container.
- This method is called when method is called, or when
- GridEditableItem.EditManager.GetColumnEditor is called.
-
-
- This method is should prepare the column editor to extract values from the edit controls residign in a TableCell of the grid.
-
-
-
-
- Gets or sets the value for each cell in a
- GridCheckBoxColumn.
-
-
-
-
- Provides a reference to the control in the corresponding grid cell of the current
- GridCheckBoxColumn.
-
-
-
-
- Gets or sets the style defining the appearance of the corresponding
- check-box.
-
-
-
-
-
-
-
-
- Gets or sets the value for each cell in a
- GridCheckBoxColumn.
-
-
-
-
- Summary description for GridCreateColumnEditorEvent.
-
-
-
-
- Summary description for GridDropDownColumnEditor.
-
-
-
-
- Base class that intruduces the editor of GridBoundColumn. THis can be an editor that creates a simple TextBox control, ot RichTexst editors, that has a single string property Text.
-
-
-
-
- Class tha implements data editing of a GridBoundColumn with a single TextBox control.
-
-
-
-
- Gets The text box instance created of extracted from a cell after calls to AddControlsToContainer or LoadControlsFromContainer methods.
-
-
-
-
- Gets the instace of the Style that would be applied to the TextBox control, when initializing in a TableCell.
-
-
-
-
- A column type for the RadGrid control that is bound to a field in a data
- source.
-
- Grid column types
-
- The default data binding (when AutoGenerateColumns property
- is set to true) generates GridBoundColumn type of columns. It
- displays each item from the DataSource field as text. This column is
- editable (implements the
- IGridEditableColumn
- interface) and provides by default GridTextColumnEditor, used for
- editing the text in each item.
- GridBoundColumn has three similar and yet different
- properties controlling its visibility and rendering in a browser in regular and in
- edit mode:
-
- Display - concerns only the appearance of the column in
- browser mode, client-side. The column will be rendered in the browser but all
- the cells will be styled with display: none. The column editor will be
- visible in edit mode.
- Visible - will stop the column cells from rendering in
- browser mode. The column will be visible in edit mode.
-
- ReadOnly - the column will be displayed according to the
- settings of previous properties in browser mode but will not appear in the
- edit-form.
-
-
-
- None of these properties can prevent you from
- accessing the column cells' content server-side using the
- UniqueName of the column.
-
-
-
-
- Grid Column types
- Adding columns design-time
- Using columns
-
-
-
- All columns in RadGrid that have editing capabilities derive from GridEditableColumn.
- This class implements the base functionality for editing, using column editors etc.
-
-
- Provides IGridEditableColumn interface, which RadGrid uses to operate with the
- state of all the editable columns.
-
-
-
-
- A Column is the main logic unit that relates the content of the grid to
- properties of the objects in the DataSource.
- The GridColumn defines the properties and methods that are common to all
- column types in RadGrid. As it is an abstract class (MustInherit in VB.NET)
- GridColumn class can not be created directly. You should inherit it and use its
- children.
-
-
- GridColumn is the base abstract class that implements the
- functionality of a grid column. All inherited classes modify the base behavior
- corresponding to the specific data that should be displayed/edited in RadGrid. The
- columns that have editing capabilities derrive from
- class. Other instances display data, buttons, and
- so on in the cells of the grid regarding the type of the Item/row in which the cell
- resides. In you code you can create only instances of the derrived classes. In order to
- display a column in the grid you should add it in the corresponding
- collection. Since the column collection is
- fully persisted in the ViewSteate you should follow the rules that apply to creating
- asp.net server controls dynamically, when adding columns to grid tables
- programmatically.
-
-
-
-
- Using the FooterStyle property lets you enhance the appearance
- of the footer section of the column. You can set forecolor, backcolor, font and content
- alignment.
-
-
-
-
- Using the HeaderStyle property lets you enhance the appearance
- of the header section of the column. You can set forecolor, backcolor, font and content
- alignment.
-
-
-
-
- Use this property to enhance the appearance of the item cells of the column. You
- can provide a custom style for Common style attributes that can be adjusted such as:
- forecolor, backcolor, font, and content alignment within the cell.
-
-
-
- Creates and initializes a new column with its base properties.
-
-
-
- The Initialize method is inherited by a derived
- GridColumn class. Is is used to reset a column of the derived
- type.
-
-
- This method is mainly used to reset properties common for all column types
- derived from GridColumn class.
- The Initialize method is usually called during data-binding, prior to the
- first row being bound.
-
-
-
-
- After a call to this method the column should add the corresponding controls
- (text, labels, input controls) into the cell given, regarding the inItem type and
- column index.
- Note: This method is called within RadGrid and is not intended
- to be used directly from your code.
-
-
-
-
- This method should be used in case you develop your own column. It returns true
- if the column supports filtering.
-
-
-
-
- Modifies the CurrentFilterFunction and
- CurrentFilterValue properties according to the function given and the
- corresponding filter text-box control in the filtering item.
-
-
-
-
- Modifies the CurrentFilterValue property according to the
- corresponding selected item in the filter text-box control in the filtering
- item.
-
-
-
-
- Sets the value of the property CurrentFilterValue as a text on the TextBox control found in the cell
-
-
-
-
-
- Gets the value of the Text property of a textbox control found in the cell, used to set the value of the CurrentFilterValue property.
-
-
-
-
-
-
- Gets a string representing a filter expression, based on the settings of all
- columns that support filtering, with a syntax ready to be used by a
- DataView object
-
-
-
-
- Instantiates the filter controls (text-box, image.) in the cell given
-
-
-
-
-
- Gets a list of filter functions based on the settings of the property.
-
-
-
-
-
-
-
- Prepares the cell of the item given, when grid is rendered.
-
-
-
-
-
-
-
-
-
-
- Resets the values of the and
- properties to their defaults.
-
-
-
-
- By default returns the SortExpression of the column. If the SortExpression is not set explicitly, it would be calculated, based on the
- DataField of the column.
-
-
-
-
-
- Calculate the default Group-by expression based on the settings of the
- DataField (if available)
-
-
- For example, if a column's DataField is ProductType the default group-by expression will be:
- 'ProductType Group By ProductType'
-
-
-
-
- Note: When implementing/overriding this method be sure to call
- the base member or call CopyBaseProperties to be sure that all base
- properties will be copied accordingly
-
- Creates a copy of the current column.
-
-
-
- This method returns true if the column is bound to the specified field
- name.
-
- The name of the DataField, which will be checked.
-
-
-
-
-
-
-
- This method should be used in case you develop your own column. It returns the
- full list of DataFields used by the column.
- GridTableView uses this to decide which DataFields
- from the specified DataSource will be inlcuded in case of
- GridTableView.RetrieveAllDataFields is set to
- false.
-
-
-
- Gets or sets a value of the currently applied filter.
-
- This property returns a string, representing the
- current value, for which the columns is filtered (the value, which the user has entered
- in the filtering text box).
-
-
-
-
- Should override if sorting will be disabled
-
-
-
- Gets or sets the current function used for filtering.
-
- This property returns a value of type
- Telerik.Web.UI.GridKnownFunction. The possible
- values are:
- GridKnownFunction.Between
- GridKnownFunction.Contains
- GridKnownFunction.Custom
- GridKnownFunction.DoesNotContain
- GridKnownFunction.EndsWith
- GridKnownFunction.EqualTo
- GridKnownFunction.GreaterThan
- GridKnownFunction.GridKnownFunction
- GridKnownFunction.GreaterThanOrEqualTo
- GridKnownFunction.IsEmpty
- GridKnownFunction.IsNull
- GridKnownFunction.LessThan
- GridKnownFunction.LessThanOrEqualTo
- GridKnownFunction.NoFilter
- GridKnownFunction.NotBetween
- GridKnownFunction.NotEqualTo
- GridKnownFunction.NotIsEmpty
- GridKnownFunction.NotIsNull
- GridKnownFunction.StartsWith
-
-
-
-
- Gets or sets the value indincating which of the filter functions should be
- available for that column. For more information see
- enumaration.
-
-
- This property returns a value of type
- Telerik.Web.UI.GridFilterListOptions. The possible
- values are:
-
- Telerik.Web.UI.GridFilterListOptions.AllowAllFilters
- Telerik.Web.UI.GridFilterListOptions.VaryByDataType
- Telerik.Web.UI.GridFilterListOptions.VaryByDataTypeAllowCustom
-
-
-
-
- Gets or sets a value indicating whether the grid should automatically postback,
- when the value in the filter text-box changes, and the the focus moves to another
- element.
-
-
- This property returns a Boolean value, indicating
- whether the grid will postback, once the focus moves to another element, and the text
- of the filtering textbox has changed.
-
-
-
-
- Gets or sets a string representing the URL to the image used in the filtering
- box.
-
-
- A string, representing the URL to the image used in the
- filtering box.
-
-
-
-
- Gets or sets a string representing the URL to the image used for sorting in
- ascending mode.
-
-
- A string, representing the URL to the image used for
- sorting in ascending mode
-
-
-
-
- Gets or sets a string representing the URL to the image used for sorting in
- descending mode.
-
-
- A string, representing the URL to the image used for
- sorting in descending mode
-
-
-
-
- Gets the string representation of the DataType property of the
- column, needed for the client-side grid instance.
-
-
-
-
- Gets or sets the template, which will be rendered in the filter item cell of the column.
-
- A value of type ITemplate.
-
-
-
- Style of the cell in the footer item of the grid, corresponding to the column.
-
-
-
-
- Use the FooterText property to specify your own or determine the current
- text for the footer section of the column.
-
-
-
-
- Gets or sets the URL of an image in the cell in the header item of the grid
- current column. You can use a relative or an absolute URL.
-
-
-
-
- Style of the cell in the header item of the grid, corresponding to the column.
-
-
-
-
- Use the HeaderText property to specify your own or determine the current
- text for the header section of the column.
-
-
-
-
- Style of the cells, corresponding to the column.
-
-
-
-
- Gets the instance of the GridTableVeiw wich owns this column instance.
-
-
-
-
- The string representing a filed-name from the DataSource that should be used when grid sorts by this column. For example:
- 'EmployeeName'
-
-
-
-
- The group-expression that should be used when grid is grouping-by this column. If
- not set explicitly, RadGrid will generate a group expression based on the DataField of
- the column (if available), using the
- method.
- The grouping can be turned on/off for columns like GridBoundColumn using
- property.
- For more information about the Group-By expressions and their syntax, see
- class.
-
-
-
-
- Get or Sets a value indicating whether a sort icon should appear next to the
- header button, when a column is sorted.
-
-
- This property returns a Boolean value, indicating
- whether a sort icon should appear next to the header button, when a column is
- sorted.
-
-
-
-
- Gets or sets a value indicating if the column and all corresponding cells would be rendered.
-
-
- This property returns a Boolean value, indicating
- whether the cells corresponding to the column, would be visible on the client, and
- whether they would be rendered on the client.
-
-
-
-
- Gets or sets a value indicating whether the cells corresponding to a column would be rendered with a 'display:none' style attribute (end-user-not-visible).
- To completely prevent cells from rendering, set the property to false, instead of the Display property.
-
-
- This property returns a Boolean value, indicating
- whether the cells corresponding to the column would be rendered with a 'display:none'
- style attribute (end-user-not-visible).
-
-
-
-
- Gets the value of the ClientID property of the GridTableView that owns this column. This property value is used by grid's client object
-
-
- The return value of this property is a string,
- representing the clientID of the GridTableView, which contains the column. This is the
- ClientID of the grid instance, followed by "_" and another string, representing the
- place of the container in the control hierarchy. For the MasterTableView, the default
- OwnerID for a column will look like: "RadGrid1_ctl01".
-
-
-
-
- Gets the value of the ClientID property of the RadGrid instance that owns this column. This property value is used by grid's client object
-
-
- This property returns a string, which represents a the
- ClientID for the control.
-
-
-
-
- Gets or sets a value indicating whether the column can be resized client-side.
- You can use this property, by setting it to false, to disable resizing for a particular
- column, while preserving this functionality for all the other columns.
-
-
- The property returns a boolean value, indicating
- whether the column can be resized on the client.
-
-
-
-
- Gets or sets a value indicating whether the column can be reordered client-side.
-
-
- This property returns a boolean value, indicating whether the column is
- reorderable. The default value is true, meaning that the column can be reordered, using
- the SwapColumns client side method.
-
-
-
-
- Gets or sets a value indicating whether you will be able to group
- Telerik RadGrid by that column. By default this property is
- true.
-
-
- A boolean value of either true, when you are able to group by
- that column, or false.
-
-
- See Telerik RadGrid manual for details about using grouping. If
- Groupable is false the column header cannot be dragged to the
- GroupPanel.
-
-
-
- Using this property, you can easily turn off grouping for one or more
- columns, while still allowing this functionality for all other columns in the
- control. This is demonstrated in the code sample below:
-
-
-
-
-
- Gets the string representation of the type-name of this instance. The value is
- used by RadGrid to determine the type of the columns persisted into the ViewState, when
- recreating the grid after postback. The value is also used by the grid client-side
- object. This property is read only.
-
-
-
-
- Gets or sets the button type of the button rendered in the header item, used
- for sorting. The possible values that this property accepts are:
- Telerik.Web.UI.GridHeaderButtonType.LinkButton
- Telerik.Web.UI.GridHeaderButtonType.PushButton
- Telerik.Web.UI.GridHeaderButtonType.TextButton
-
-
- The return value for this property is of type
- Telerik.Web.UI.GridHeaderButtonType
-
-
-
-
- Gets or sets the order index of column in the collection of
- . Use
- method for reordering the columns.
-
-
-
- We recommend using this property only for getting the order index for a
- specific column instead of setting it. Use
- method for reordering columns.
-
- Note that changing the column order index will change the order of the cells
- in the grid items, after the grid is rebound.
-
- The value of the property would not affect the order of the column in the
- collection.
-
-
-
- integer representing the current column index. You should have
- in mind that GridExpandColumn and RowIndicatorColumn
- are always in front of data columns so that's why you columns will start from index
- 2.
-
-
-
- protected void RadGrid1_PreRender(object sender, EventArgs e)
- {
- foreach (GridBoundColumn column in RadGrid1.MasterTableView.Columns)
- {
- Response.Write(column.UniqueName + column.OrderIndex + "<br>");
- }
-
- RadGrid1.MasterTableView.SwapColumns(2, 4);
-
- foreach (GridBoundColumn column in RadGrid1.MasterTableView.Columns)
- {
- Response.Write(column.UniqueName + column.OrderIndex + "<br>");
- }
- }
-
-
- Protected Sub RadGrid1_PreRender(sender As Object, e As EventArgs)
- Dim column As GridBoundColumn
- For Each column In RadGrid1.MasterTableView.Columns
- Response.Write((column.UniqueName + column.OrderIndex + "<br>"))
- Next column
-
- RadGrid1.MasterTableView.SwapColumns(2, 4)
-
- Dim column As GridBoundColumn
- For Each column In RadGrid1.MasterTableView.Columns
- Response.Write((column.UniqueName + column.OrderIndex + "<br>"))
- Next column
- End Sub 'RadGrid1_PreRender
-
-
-
-
-
- This property is supposed for developers of new grid columns. It gets whether
- a column is currently ReadOnly. The ReadOnly property determines whether a column
- will be editable in edit mode. A column for which the ReadOnly property is true
- will not be present in the automatically generated edit form.
-
- A boolean value, indicating whether a specific column is editable.
-
-
-
- Specifies the vertical collumn number where this column will appear when
- using EditForms editing mode and the form is autogenerated. See the remarks for
- details.
-
-
- A practicle example of using this property is to deterimine the number of
- columns rendered in the edit form. If there will be only one column in the rendered
- edit form, when we retrieve the value of this property for a column, as shown in
- the code below:
-
- it will be equal to 0, meaning the the column belongs to the first group of
- columns in the edit form.
-
-
-
-
- Each column in Telerik RadGrid has an UniqueName
- property (string). This property is assigned automatically by the designer (or the
- first time you want to access the columns if they are built dynamically).
-
-
- You can also set it explicitly, if you prefer. However, the automatic
- generation handles most of the cases. For example a
- GridBoundColumn with DataField 'ContactName'
- would generate an UniqueName of 'ContactName'.
- Additionally, there may be occasions when you will want to set the UniqueName
- explicitly. You can do so simply by specifying the custom name that you want to
- choose:
-
-
-
- When you want to access a cell within a grid item, you
- should use the following code to obtain the right cell:
- TableCell cell = gridDataItem["ColumnUniqueName"];
- or
- gridDataItem["ColumnUniqueName"].Text =
- to access the Text property
- Using this property you can index objects of type
- %GridDataItem:GridDataItem% or
- %GridEditFormItem:GridEditFormItem% (or all descendants of
- %GridEditableItem:GridEditableItem% class)
- In events related to creating, binding or for commands in items, the event
- argument has a property Item to access the item that event is
- fired for. To get an instance of type GridDataItem, you should use
- the following:
- //presume e is the event argument object
- if (e.Item is GridDataItem)
- {
- GridDataItem gridDataItem = e.Item as GridDataItem;
-
-
-
-
- String that formats the HeaderText when the column is displayed in an edit form
-
-
- The following code demonstrates one possible use of this property:
-
-
-
-
-
-
-
-
-
- In this way, once a record enters edit mode, the name of the column will be
- followed by the custom text entered in the example above.
- [ASPX/ASCX]
- <radG:GridBoundColumn DataField="CustomerID"
- HeaderText="CustomerID"
- SortExpression="CustomerID"
- UniqueName="CustomerID"
- EditFormHeaderTextFormat="{0} is currently in edit mode"
- >
- </radG:GridBoundColumn>
-
-
-
-
- Gets or sets (see the Remarks) the type of the data from the DataField as it
- was set in the DataSource.
-
-
- The DataType property supports the following base .NET Framework data
- types:
-
- Boolean
- Byte
- Char
- DateTime
- Decimal
- Double
- Int16
- Int32
- Int64
- SByte
- Single
- String
- TimeSpan
- UInt16
- UInt32
- UInt64
-
-
-
-
-
- Use this property to set width to the filtering control (depending on the column type, this may be a normal textbox, RadNumericTextBox, RadDatePicker, etc.)
-
-
-
-
- Interface that RadGrid uses to determine the editable columns, their current state etc.
-
-
-
- protected void RadGrid1_UpdateCommand(object source, Telerik.Web.UI.GridCommandEventArgs e)
- {
- GridEditableItem editedItem = e.Item as GridEditableItem;
- GridEditManager editMan = editedItem.EditManager;
-
- foreach( GridColumn column in e.Item.OwnerTableView.RenderColumns )
- {
- if ( column is IGridEditableColumn )
- {
- IGridEditableColumn editableCol = (column as IGridEditableColumn);
- if ( editableCol.IsEditable )
- {
- IGridColumnEditor editor = editMan.GetColumnEditor( editableCol );
-
- string editorType = editor.ToString();
- string editorText = "unknown";
- object editorValue = null;
-
- if ( editor is GridTextColumnEditor )
- {
- editorText = (editor as GridTextColumnEditor).Text;
- editorValue = (editor as GridTextColumnEditor).Text;
- }
-
- if ( editor is GridBoolColumnEditor )
- {
- editorText = (editor as GridBoolColumnEditor).Value.ToString();
- editorValue = (editor as GridBoolColumnEditor).Value;
- }
-
- if ( editor is GridDropDownColumnEditor )
- {
- editorText = (editor as GridDropDownColumnEditor).SelectedText + "; " +
- (editor as GridDropDownColumnEditor).SelectedValue;
- editorValue = (editor as GridDropDownColumnEditor).SelectedValue;
- }
-
- try
- {
- DataRow[] changedRows = this.EmployeesData.Tables["Employees"].Select( "EmployeeID = " + editedItem.OwnerTableView.DataKeyValues[editedItem.ItemIndex]["EmployeeID"] );
- changedRows[0][column.UniqueName] = editorValue;
- this.EmployeesData.Tables["Employees"].AcceptChanges();
- }
- catch(Exception ex)
- {
- RadGrid1.Controls.Add(new LiteralControl ("<strong>Unable to set value of column '" + column.UniqueName + "'</strong> - " + ex.Message));
- e.Canceled = true;
- break;
- }
- }
- }
- }
- }
-
-
- Private Sub RadGrid1_UpdateCommand(ByVal source As System.Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs) Handles RadGrid1.UpdateCommand
-
- Dim editedItem As GridEditableItem = CType(e.Item, GridEditableItem)
- Dim editMan As GridEditManager = editedItem.EditManager
-
- Dim column As GridColumn
-
- For Each column In e.Item.OwnerTableView.Columns
- If Typeof column Is IGridEditableColumn Then
- Dim editableCol As IGridEditableColumn = CType(column, IGridEditableColumn)
- If (editableCol.IsEditable) Then
- Dim editor As IGridColumnEditor = editMan.GetColumnEditor(editableCol)
-
- Dim editorType As String = CType(editor, Object).ToString()
- Dim editorText As String = "unknown"
- Dim editorValue As Object = Nothing
-
- If (Typeof editor Is GridTextColumnEditor) Then
- editorText = CType(editor, GridTextColumnEditor).Text
- editorValue = CType(editor, GridTextColumnEditor).Text
- End If
-
- If (Typeof editor Is GridBoolColumnEditor) Then
- editorText = CType(editor, GridBoolColumnEditor).Value.ToString()
- editorValue = CType(editor, GridBoolColumnEditor).Value
- End If
-
- If (Typeof editor Is GridDropDownColumnEditor) Then
- editorText = CType(editor, GridDropDownColumnEditor).SelectedText & "; " & CType(editor, GridDropDownColumnEditor).SelectedValue
- editorValue = CType(editor, GridDropDownColumnEditor).SelectedValue
- End If
-
- Try
- Dim changedRows As DataRow() = Me.EmployeesData.Tables("Employees").Select("EmployeeID = " & editedItem.OwnerTableView.DataKeyValues(editedItem.ItemIndex)("EmployeeID"))
- changedRows(0)(column.UniqueName) = editorValue
- Me.EmployeesData.Tables("Employees").AcceptChanges()
- Catch ex As Exception
- RadGrid1.Controls.Add(New LiteralControl("<strong>Unable to set value of column '" & column.UniqueName & "'</strong> - " + ex.Message))
- e.Canceled = True
- End Try
-
- End If
- End If
- Next
- End Sub
-
-
- Using column editors
-
-
-
- Get value based on the current IsEditable state, item edited state and ForceExtractValue setting.
-
- item to check to extract values from
-
-
-
- Extracts the values from the editedItem and fills the names/values pairs for each data-field edited by the column in the newValues dictionary.
-
- dictionary to fill. This param should not be null (Nothing in VB.NET)
- the GridEditableItem to extract values from
-
-
-
- Get whether a column is currently read-only
-
-
-
-
- Gets the column editor instance for this column
-
-
-
-
- Gets the GridColumn instance implementing this interface
-
-
-
-
- Force RadGrid to extract values from EditableColumns that are ReadOnly (or IsEditable is false).
-
-
-
-
- Extracts the values from the editedItem and fills the names/values pairs for each data-field edited by the column in the newValues dictionary.
-
- dictionary to fill. This param should not be null (Nothing in VB.NET)
- the GridEditableItem to extract values from
-
-
-
- Get value based on the current IsEditable state, item edited state and ForceExtractValue setting.
-
- item to check to extract values from
-
-
-
- Get the current colum editor. If the column editor is not assigned at the moment the column will search for the ColumnEditorID on the page or should
- create its default column editor
-
-
-
-
- Convert the emty string to null when extracting values for inserting, updating, deleting
-
-
-
-
- Gets or sets the readonly status of the column. The column will be displayed in
- browser mode (unless its Visible property is false)
- but will not appear in the edit-form.
-
-
- A boolean value, indicating whether a column is
- ReadOnly.
-
-
-
-
- Force RadGrid to extract values from EditableColumns that are ReadOnly (or IsEditable is false).
-
-
-
- Resets the GridBoundColumn to its initial state.
-
-
-
- Resets the specified cell in the GridBoundColumn to its initial
- state.
-
-
-
-
- Gets or sets the field name from the specified data source to bind to the
- GridBoundColumn.
-
-
- A string, specifying the data field from the data
- source, from which to bind the column.
-
-
-
-
- Gets or sets the field name from the specified data source to bind to the
- GridBoundColumn.
-
-
- A string, specifying the data field from the data
- source, from which to bind the column.
-
-
-
-
- Sets or gets whether cell content must be encoded. Default value is
- false.
-
-
-
-
- Sets or gets default text when column is empty. Default value is
- " "
-
-
-
-
- Gets or Sets an integer, specifying the maximum number of characters, which will
- be accepted in the edit textbox for the field, when in edit mode.
-
-
- An integer, specifying the maximum number of
- characters, which the item will accept when in edit mode.
-
-
-
-
-
- Use the DataFormatString property to provide a custom format for the items
- in the column.
- The data format string consists of two parts, separated by a colon, in the form {
- A : Bxx }.
- For example, the formatting string {0:C2} displays a currency formatted number with two
- decimal places.
- Note: The entire string must be enclosed in braces to indicate
- that it is a format string and not a literal string. Any text outside the braces is
- displayed as literal text.
- The value before the colon (A in the general
- example) specifies the parameter index in a zero-based list of parameters.
-
- Note: This value can only be set to 0 because there is only one
- value in each cell.
- The value before the colon (A in the general
- example) specifies the parameter index in a zero-based list of parameters.
- The character after the colon (B in the general
- example) specifies the format to display the value in. The following table lists the
- common formats.
-
-
-
-
-
- Format character
-
- Description
-
-
- C
-
- Displays numeric values in currency format.
-
-
- D
-
- Displays numeric values in decimal format.
-
-
- E
-
- Displays numeric values in scientific (exponential)
- format.
-
-
- F
-
- Displays numeric values in fixed format.
-
-
- G
-
- Displays numeric values in general format.
-
-
- N
-
- Displays numeric values in number format.
-
-
- X
-
- Displays numeric values in hexadecimal
- format.
-
- Note: The format character is not case-sensitive, except for
- X, which displays the hexadecimal characters in the case specified.
-
The value after the format character
- (xx in the general example) specifies the number of
- significant digits or decimal places to display.
- For more information on formatting strings, see
- Formatting
- Overview (external link to MSDN library).
-
-
- Gets or sets the string that specifies the display format for items in the
- column.
-
-
- A string that specifies the display format for items in
- the column
-
-
-
- Gets or sets whether the column data can be filtered.
- A boolean value, indicating whether the column data can be filtered.
-
-
- Gets or sets a whether the column data can be sorted.
-
- A boolean value, indicating whether the column data can
- be sorted.
-
-
-
-
- Gets a boolean value, indicating whether the column is editable. A ReadOnly
- column will return a false value for this property. The property is readOnly.
-
-
- A boolean value, indicating whether the column is
- editable
-
-
-
- Defines what button will be rendered in a GridButtonColumn
-
-
- Renders a standard hyperlink button.
-
-
- Renders a standard button.
-
-
- Renders an image that acts like a button.
-
-
- Defines what kind of confirm dialog will be used in a GridButtonColumn
-
-
- Standard browser confirm dialog.
-
-
- RadWindow confirm dialog.
-
-
- It displays a button for each item in the column.
- Grid column types
-
-
- This column renderes a button of the specified ButtonType in each corresponding
- cell of the items of type and
- . You can use this buttons to fire command
- events that can be handeled in event
- handler. This, in combination with the
- event
- bubbling mechanism in Telerik RadGrid, allows you to create a
- column of custom button controls, such as Add,
- Remove, Select or Edit
- buttons.
-
- The available buttons types are:
- PushButton,LinkButton and ImageButton.
- Telerik RadGrid comes with two types of button columns:
-
- Select - when a button in this column is pressed, it
- will select the whole row. The Select column below uses a
- PushButton.
- Remove selection - when a button in this column is
- pressed, it will delete the row. The Remove selection column
- below uses a LinkButton.
-
-
-
-
-
- Grid Column types
- Adding columns design-time
- Using columns
-
-
- Constructs a new GridButtonColumn object.
-
-
-
- The Initialize method is inherited by a derived
- GridButtonColumn class. Is is used to reset a column of the derived
- type.
-
-
-
-
- After a call to this method the column should add the corresponding button into
- the cell given, regarding the inItem type and column index.
- Note: This method is called within RadGrid and is not intended
- to be used directly from your code.
-
-
-
- Returns a copy of the GridButtonColumn.
-
-
-
- Gets or sets the title that will be shown on the RadWindow confirmation dialog when a button
- in this column is clicked.
-
-
-
-
- Gets or sets a value indicating the type of the button that will be rendered. The
- type should be one of the specified by the
- enumeration.
-
-
-
-
- LinkButton
- Renders a standard hyperlink button.
-
- PushButton
- Renders a standard button.
-
- ImageButton
- Renders an image that acts like a
- button.
-
-
-
-
- Gets or sets the CssClass of the button
-
-
-
-
- Gets or sets the width of the Confirm Dialog (if it is a RadWindow)
-
-
-
-
- Gets or sets the height of the Confirm Dialog (if it is a RadWindow)
-
-
-
-
- Gets or sets a value defining the name of the command that will be fired when a
- button in this column is clicked.
-
-
-
-
-
-
- Fired By controls within DataItems - showing and
- editing data
-
-
CancelCommandName
-
Represents the Cancel command name. Fires RadGrid.CancelCommand
- event and sets Item.Edit to false for the parent
- Item.
-
-
DeleteCommandName
-
Represents the Delete command name. Fires RadGrid.DeleteCommand
- event. Under .Net 2.0 performs automatic delete operation and then sets
- Item.Edit to false.
-
-
UpdateCommandName
-
Represents the Update command name. Fires RadGrid.UpdateCommand
- event. Under .Net 2.0 performs automatic update operation and then sets
- Item.Edit to false.
-
-
- EditCommandName
-
Represents the Edit command name. Sets Item.Edit to
- true.
-
-
- SelectCommandName
-
Represents the Select command name. Sets Item.Selected to
- true.
-
-
- DeselectCommandName
-
Represents the Deselect command name. Sets Item.Selected to
- false.
-
-
- Can be fired by controls within any Item
-
-
- InitInsertCommandName
-
By default grid renders an image button in the CommandItem. Opens
- the insert item.
-
-
- PerformInsertCommandName
-
Fires RadGrid.InsertCommand event. Under .Net 2.0 Perfoms
- automatic insert operation and closes the insert item.
-
-
- RebindGridCommandName
-
By default grid renders an image button in the CommandItem. Forces
- RadGrid.Rebind
-
-
- SortCommandName
-
Represents the Sort command name. By default it is fired by image buttons in the
- header item when Sorting is enabled. The argument for the SortCommand
- must be the DataField name for the DataField to be
- sorted.
-
-
-
-
- Gets or sets an optional parameter passed to the Command event along with the
- associated
- CommandName.
-
-
-
-
- Use the DataTextField property to specify the field name
- from the data source to bind to the
- Text property of the
- buttons in the
- GridButtonColumn object.
- Binding the column to a field instead of directly setting the Text
- property allows you to display different captions for the buttons in the
- GridButtonColumn by using
- the values in the specified field.
- Tip: This property is most
- often used in combination with
-
- DataTextFormatString Property.
-
-
- Gets or sets a value from the specified datasource field. This value will then be
- displayed in the GridBoundColumn.
-
-
-
-
-
-
-
-
-
-
-
-
- [ASPX/ASCX]<br/><br/><radg:RadGrid id=<font class="string">"RadGrid1"</font> runat=<font class="string">"server"</font>><br/> <MasterTableView AutoGenerateColumns=<font class="string">"False"</font>><br/> <Columns><br/> <radg:GridButtonColumn HeaderText=<font class="string">"Customer ID"</font><font color="red">DataTextField=<font class="string">"CustomerID"</font></font><br/><font color="red">DataTextFormatString=<font class="string">"Edit Customer {0}"</font></font> ButtonType=<font class="string">"LinkButton"</font> UniqueName=<font class="string">"ButtonColumn"</font>><br/> </radg:GridButtonColumn>
-
-
-
-
-
-
-
-
-
- Use the DataTextFormatString property to provide a custom
- display format for the caption of the buttons in the
- GridButtonColumn.
- Note: The entire
- string must be enclosed in braces to indicate that it is a format string and not a
- literal string. Any text outside the braces is displayed as literal text.
-
-
-
-
-
-
-
-
-
-
- [ASPX/ASCX]<br/><br/><radg:RadGrid id=<font color="black"><font class="string">"RadGrid1"</font> runat=<font class="string">"server"</font>><br/> <MasterTableView AutoGenerateColumns=<font class="string">"False"</font>><br/> <Columns><br/> <radg:GridButtonColumn HeaderText=<font class="string">"Customer ID"</font></font><font color="red">DataTextField=<font class="string">"CustomerID"</font><br/>DataTextFormatString=<font class="string">"Edit Customer {0}"</font></font> ButtonType=<font class="string" color="black">"LinkButton"</font> UniqueName=<font color="black"><font class="string">"ButtonColumn"</font>><br/> </radg:GridButtonColumn></font>
-
-
-
- Gets or sets the string that specifies the display format for the caption in each
- button.
-
-
-
- Gets or sets a value indicating the text that will be shown for a button.
-
-
-
- Gets or sets a value indicating the URL for the image that will be used in a
- Image button. should be set to
- ImageButton.
-
-
-
-
- Gets or sets the text that will be shown on the confirmation dialog when a button
- in this column is clicked. The prompt is automatically enabled when this property is
- set.
-
-
-
-
- Gets or sets a value indicating whether this column can be used for grouping. If
- set to false the column header cannot be dragged to the
- .
-
-
-
- Gets the status of property.
-
-
-
-
- If the corresponding is in edit mode
- specifies whether this column will
- render an Enabled=true button control, when the corresponding item is edit
- mode.
-
-
-
-
-
- Displays a CheckBox control for each item in the column. This allows you
- to edit for example Boolean field(s) from data table(s).
-
- Grid column types
-
- This column is editable (implements the IGridEditableColumn
- interface) and provides by default GridBoolColumnEditor, used for
- editing the text in each item. You can persist the checked state of a checkbox, if you
- use it within GridTemplateColumn
- (
- see here).
-
-
-
-
- Grid Column types
- Adding columns design-time
- Using columns
- Similarities/Differences between GridCheckBoxColumn and GridTemplateColumn with
- checkbox
-
-
-
- Gets or sets the field name from the specified data source to bind to the
- column.
-
-
- A string, specifying the data field from the data
- source, from which to bind the column.
-
-
-
- Gets or sets a whether the column data can be sorted.
-
- A boolean value, indicating whether the column data can
- be sorted.
-
-
-
- Gets or sets whether the column data can be filtered.
- A boolean value, indicating whether the column data can be filtered.
-
-
-
- Gets a boolean value, indicating whether the column is editable. A ReadOnly
- column will return a false value for this property. The property is readOnly.
-
-
- A boolean value, indicating whether the column is
- editable.
-
-
-
-
- A special type of GridButtonColumn, including a delete buttons in each row. It
- provides the functionality of erasing records client-side, without making a round trip
- to the server.
-
-
- This optimizes the performance and the source data is automatically refreshed
- on the subsequent post to the server. The user experience is improved because the
- delete action is done client-side and the table presentation is updated
- immediately.
- Its ConfirmText property can be assigned like with the default
- GridButtonColumn showing a dialog which allows the user to cancel the
- action.
-
-
-
- <radG:GridClientDeleteColumn ConfirmText="Are you sure you want to delete the selected row?" HeaderStyle-Width="35px" ButtonType="ImageButton" ImageUrl="~/RadControls/Grid/Skins/WebBlue/Delete.gif" />
-
-
- Client-side delete feature
- Grid column types
- Client-side delete
- Web Grid
-
-
-
- Gets or sets a value indicating the URL for the image that will be used in a
- Image button. should be set to
- ImageButton.
-
-
-
-
- Displays a Checkbox control for each item in the column. This
- allows you to select grid rows client-side automatically when you change the status of
- the checkbox to checked.
-
- Column types
- Client selection
-
- If you choose AllowMultiRowSelection = true for the grid, a
- checkbox will be displayed in the column header to toggle the checked/selected stated
- of the rows simultaneously (according to the state of that checkbox in the
- header).
-
- To enable this feature you need to turn on the client selection of the grid
- (ClientSettings -> Selecting -> AllowRowSelect = true).
-
-
-
-
- Grid Column types
- Adding columns design-time
- Using columns
-
-
-
- The collection of columns of RadGrid or its tables. Accessible through
- Columns property of RadGrid and GridTableView (MasterTableView)
- classes.
-
-
- Its items are of the available Grid
- column
- types.
-
-
-
- GridBoundColumn boundColumn;
- boundColumn = new GridBoundColumn();
- boundColumn.DataField = "CustomerID";
- boundColumn.HeaderText = "CustomerID";
- RadGrid1.MasterTableView.Columns.Add(boundColumn);
-
- boundColumn = new GridBoundColumn();
- boundColumn.DataField = "ContactName";
- boundColumn.HeaderText = "Contact Name";
- RadGrid1.MasterTableView.Columns.Add(boundColumn);
-
- RadGrid1.MasterTableView.Columns.Add( new GridExpandColumn() );
-
-
- Dim boundColumn As GridBoundColumn
- boundColumn = New GridBoundColumn()
- boundColumn.DataField = "CustomerID"
- boundColumn.HeaderText = "CustomerID"
- RadGrid1.MasterTableView.Columns.Add(boundColumn)
-
- boundColumn = New GridBoundColumn()
- boundColumn.DataField = "ContactName"
- boundColumn.HeaderText = "Contact Name"
- RadGrid1.MasterTableView.Columns.Add(boundColumn)
-
- RadGrid1.MasterTableView.Columns.Add(New GridExpandColumn())
-
-
-
-
- Adds a column object to the GridColumnCollection.
- The GridColumn object to add to the collection.
-
-
-
- Determines whether the CridColumnCollection contains the value specified
- by the given GridColumn object.
-
-
- true if the GridColumn is found in the
- GridColumnCollection; otherwise, false.
-
- GridColumn object to locate in the GridColumnCollection.
-
-
-
- Determines the index of a specific column in the
- GridColumnCollection.
-
-
- The index of value if found in the collection;
- otherwise, -1.
-
- The object to locate in the GridColumnCollection.
-
-
-
- Inserts a column to the GridColumnCollectino at the specified
- index.
-
-
- The zero-based index at which column should be
- inserted.
-
-
-
- The to insert into the collection.
-
-
-
-
-
- Removes the first occurrence of an object from the
- GridColumnCollection.
-
- The object to remove from the collection.
-
-
-
- Determines the index of a specific column in the
- GridColumnCollection.
-
-
- The index of value if found in the collection;
- otherwise, -1.
-
-
- The to locate in the
- GridColumnCollection.
-
-
-
-
- Removes the first occurrence of a column from the
- GridColumnCollection.
-
- The column to remove from the collection.
-
-
-
- Removes the GridColumnCollection item at the specified
- index.
-
- The zero-based index of the item(column) to remove.
-
-
-
- Gets the first column with UniqueName found. Throws GridException if no column is found.
-
-
-
-
-
-
- Gets the first column with UniqueName found. Returns null if no column is found.
-
-
-
-
-
-
- Gets the first column found bound to the DataField. Throws GridException if no column is bound to this DataField
-
-
-
-
-
-
- Gets the first column found bound to the DataField. Returns null is no column is bound to this DataField
-
-
-
-
-
-
- Gets all columns found bound to the DataField specified. Returns null is no column is bound to this DataField
-
-
-
-
-
- Gets the number of columns added programmatically or declaratively.
-
- Note that this is not the actual number of column in a
- . See also
-
-
- RenderColumns Property (Telerik.Web.UI.GridTableView)
-
-
-
- If the column/detail table structure is created after the control has been
- initialized (indicated by RadGrid.Init event ) the state of the
- columns/detail tables may have been lost. This happens when properties have been set to
- GridColumn/GridTableView instance before it has been
- added to the corresponding collection of
- Columns/DetailTables. Then a
- GridException is thrown with message: "Failed accessing
- GridColumn by index. Please verify that you have specified the structure of RadGrid
- correctly."
-
-
-
-
-
- Here is the mechanism which Telerik RadGrid uses to present
- values for GridDropDownColumn. Consider the snippet below:
- <radg:GridDropDownColumn
- UniqueName="LevelID"
- ListDataMember="Level"
- ListTextField="Description"
- ListValueField="LevelID"
- HeaderText="LevelID"
- DataField="LevelID"
- />
-
-
- As you can see, a requirement for the proper functioning of
- GridDropDownColumn is that all column
- values referenced by the DataField
- attribute match the column values referenced by the
- ListValueField attribute.
- If there are values in the LevelID column of the LevelID table which do not
- have corresponding equal values in the LevelID column of the Level table, then
- the grid will display the default first value from the Description column as it
- will not "know" what is the correct field.
-
-
-
- Displays a DropDown control for each item in the column. This allows you
- to edit for example lookup field(s) from data table(s).
-
- Grid column types
- Grid Column types
- Adding columns design-time
- Using columns
-
-
-
- The ListDataMember property points to the data table (part
- of the dataset used for grid data-source) which is the source for the
- GridDropDownColumn generation.
-
-
-
-
- A string, specifying the ID of the datasource control, which will be used to
- populate the dropdown with data.
-
-
- A string, specifying the ID of the datasource control,
- which will be used to populate the dropdown with data.
-
-
-
-
- The ListTextField points to the column in the data table
- from which the grid will extract the values for the dropdown.
-
-
-
-
- The ListValueField points to the column in the data table
- which will be used as a pointer to retrieve the items for the dropdown in the
- GridDropDownColumn.
-
-
-
-
- The DataField property points to the column in the grid
- data-source containing values which will be compared at a later stage with the
- values available in the column, referenced by the
- %ListValueField:ListValueField% property.
-
-
-
-
- A Boolean value, indicating whether the dropdown column will be bound to a
- default value/text when there is no data source specified, from which to fetch the
- data.
-
-
- A Boolean value, specifying whether the dropdown column
- accepts EmptyListItemText and EmptyListItemValue strings.
-
-
-
-
- A string, specifying the text to be displayed in normal mode, when there is no
- Data Source specified for the column. In edit mode, this value is rendered as a
- dropdown list item. When in edit mode, and there is a valid DataSource specified for
- the control, this value is appended as the first item of the dropdown box.
-
-
- A string, specifying the text to be displayed in
- normal/edit mode, when there is no Data Source specified for the column.
-
-
-
-
- A string value, representing the value, associated with the
- .
-
-
- A string value, representing the value, associated with
- the .
-
-
-
-
- Gets or sets the type of the dropdown control associated with the column.
-
-
- Returns a value from the GridDropDownColumnControlType enumeration; default value is RadComboBox.
-
-
-
-
- A Boolean value, indicating whether a dropdown column is editable. If it is
- editable, it will be represented as an active dropdown box in edit mode.
-
-
- A Boolean value, indicating whether a dropdown column
- is editable.
-
-
-
- Gets or sets a whether the column data can be sorted.
-
- A boolean value, indicating whether the column data can
- be sorted.
-
-
-
-
- A Boolean property, which specifies whether filtering will be enabled for the
- column.
-
-
- A Bollean value, indicating whether a particular
- dropdown column can be filtered.
-
-
-
-
- Force RadGrid to extract values from EditableColumns that are ReadOnly.
- See also the method.
-
-
-
-
- No values would be extracted from ReadOnly column
-
-
-
-
- Values will be extracted only when an item is NOT in edit mode
-
-
-
-
- Values will be extracted only when an item is in edit mode
-
-
-
-
- Values will be extracted in all cases.
-
-
-
-
- Initially only the [Edit] button is shown. When it is pressed, the [Update] and
- [Cancel] appear at its place and the cells on this row become editable.
-
- Grid column types
- Web Grid
-
-
-
- Grid Column types
- Adding columns design-time
- Using columns
-
-
-
- Gets or sets a value indicating what type of buttons will be used in the
- GridEditCommandColumn items.
-
-
-
-
- Gets or sets a string representing the text that will be used for the Cancel
- button, in the Edit/Insert form.
-
- string, representing the text that will be used for the Cancel button.
-
-
- string, representing the text that will be used for the Edit button.
-
- Gets or sets a string, representing the text of the edit linkbutton, which is
- located in the GridEditCommandColumn, and which will replace the default "Edit"
- text.
-
-
-
-
- A string, representing the text that will be used for
- the Update button.
-
-
- Gets or sets a string, representing the text that will be used for the Update
- button.
-
-
-
-
- A string, representing the text that will be used for
- the Insert button.
-
-
- Gets or sets a string, representing a text, which will be displayed instead of
- the default "Insert" text for the GridEditFormInsertItem item.
-
-
-
-
- Gets or sets the URL for the image that will be used to fire the Insert command.
- This property should be used in conjunction with ButtonType set to
- ImageButton.
-
- string, representing the URL of the image that is used.
-
-
-
- Gets or sets the URL for the image that will be used to fire the Update command.
- This property should be used in conjunction with set
- to ImageButton.
-
- string, representing the URL of the image that is used.
-
-
-
- A string, representing the URL of the image that is
- used.
-
-
- Gets or sets the URL for the image that will be used to fire the Edit command.
- This property should be used in conjunction with ButtonType set to
- ImageButton.
-
-
-
-
-
- A string, representing the url path to the image that will be used instead of the
- default cancel linkbutton, in the EditForm.
-
-
- A string, representing the url path to the image that
- will be used instead of the default cancel linkbutton, in the EditForm.
-
-
-
-
-
-
-
- Gets or sets a unique name for this column. The unique name can be used to
- reference particular columns, or cells within grid rows.
-
-
- A string, representing the Unique name of the
- column.
-
-
-
-
- This column appears when the grid has a hierarchical structure, to facilitate the
- expand/collapse functionality. The expand column is always placed in front of all other
- grid content columns and can not be moved.
-
- Column Types
- How to hide images of ExpandCollapse column when no records
-
-
-
- Gets or sets a string, specifying the URL to the image, which will be used
- instead of the default Expand image for the GridGroupSplitterColumn (the plus
- sign).
-
-
- A string, specifying the URL to the image, which will
- be used instead of the default Expand image for the GridGroupSplitterColumn
-
-
-
-
- Gets or sets a string, specifying the URL to the image, which will be used
- instead of the default Collapse image for the GridGroupSplitterColumn (the minus
- sign).
-
-
- A string, specifying the URL to the image, which will
- be used instead of the default Collapse image for the GridGroupSplitterColumn
-
-
-
-
- Gets a Telerik.Web.UI.GridExpandColumnType value, indicating the type of the
- button. The button of the GridExpandColumn is always of type ImageButton.
-
-
- A Telerik.Web.UI.GridExpandColumnType value, indicating the type of the
- button.
-
-
-
-
- Gets or sets a string, specifying the Unique name of the column. The default value
- is "ExpandColumn".
-
- function
- GridCreated() {
- }
-
-
-
- A string, specifying the Unique name of the
- column.
-
-
-
-
- Gets a Boolean value indicating whether the
- GridGroupSplitterColumn is groupable. This value is always false.
-
-
- Gets a Boolean value indicating whether the
- GridGroupSplitterColumn is groupable.
-
-
-
-
- Gets a Boolean value, indicating whether the GridExpandColumn is reorderable.
- This value is always false, due to the specificity of the column, which should always
- be positioned first.
-
-
- A Boolean value, indicating whether the
- GridExpandColumn is reorderable.
-
-
-
-
- Gets a Boolean value, indicating whether the GridExpandColumn is resizable.
- This value is always false, due to the specificity of the column, which should always
- be positioned first.
-
-
- A Boolean value, indicating whether the
- GridExpandColumn is resizable.
-
-
-
-
- Gets a Boolean value, indicating whether the GridExpandColumn is visible.
- This value is always false, due to the specificity of the column.
-
-
- A Boolean value, indicating whether the
- GridExpandColumn is visible.
-
-
-
-
- Gets or sets a string, representing the CommandName of the GridExpandColumn. The
- command name's default value is "ExpandCollapse". It can be used to determine the
- type of command in the ItemCommand event handler.
-
- function
- GridCreated() {
- }
-
-
-
- A string, representing the CommandName of the
- GridExpandColumn.
-
-
-
-
- This column appears when grouping is enabled, to facilitate the expand/collapse
- functionality. The group splitter column is always placed first and can not be
- moved.
-
- Grid Column types
- Grouping demo with GridGroupSplitterColumn
-
-
-
- Gets or sets a string, specifying the URL to the image, which will be used
- instead of the default Expand image for the GridGroupSplitterColumn (the plus
- sign).
-
-
- A string, specifying the URL to the image, which will
- be used instead of the default Expand image for the GridGroupSplitterColumn
-
-
-
-
- Gets or sets a string, specifying the URL to the image, which will be used
- instead of the default Collapse image for the GridGroupSplitterColumn (the minus
- sign).
-
-
- A string, specifying the URL to the image, which will
- be used instead of the default Collapse image for the GridGroupSplitterColumn
-
-
-
-
- Gets a Boolean value indicating whether the
- GridGroupSplitterColumn is groupable. This value is always false.
-
-
- Gets a Boolean value indicating whether the
- GridGroupSplitterColumn is groupable.
-
-
-
-
-
- This property is for internal usage.
-
-
-
- An enumeration, used to get/set the button type of the headers of the
- columns. The default value is LinkButton. The possible values are:
-
- LinkButton
- PushButton
- TextButton
-
- If set to a value other than LinkButton, the property is only honored when
- sorting is enabled.
-
-
-
-
- Each row in a Hyperlink column will contain a predefined
- hyperlink. This link is not the same for the whole column and can be defined for each
- row individually.
-
- Grid column types
-
- The content of the column can be bound to a field in a data source or to a
- static text. You can customize the look of the links by
- using
- CSS classes.
- You can set multiple fields to a GridHyperlinkColumn through
- its DataNavigateUrlFields property. These fields can later be used
- when setting the DataNavigateUrlFormatString property and be part
- of a query string:
-
-
- Grid Column types
- Adding columns design-time
- Using columns
-
-
-
- Gets or sets a string, representing a comma-separated enumeration of DataFields
- from the data source, which will form the url of the windwow/frame that the hyperlink
- will target.
-
-
- A string, representing a comma-separated enumeration of
- DataFields from the data source, which will form the url of the windwow/frame that the
- hyperlink will target.
-
-
-
-
- Gets or sets a string, specifying the FormatString of the DataNavigateURL.
- Essentially, the DataNavigateUrlFormatString property sets the formatting for the url
- string of the target window or frame.
-
-
- A string, specifying the FormatString of the
- DataNavigateURL.
-
-
-
-
- Gets or sets a string, representing the DataField name from the data source,
- which will be used to supply the text for the hyperlink in the column. This text can
- further be customized, by using the DataTextFormatString property.
-
-
- A string, representing the DataField name from the data
- source, which will be used to supply the text for the hyperlink in the column.
-
-
-
-
- Gets or sets a string, specifying the format string, which will be used to format
- the text of the hyperlink, rendered in the cells of the column.
-
-
- A string, specifying the format string, which will be
- used to format the text of the hyperlink, rendered in the cells of the column.
-
-
-
-
- Gets or sets a string, specifying the url, to which to navigate, when a hyperlink
- within a column is pressed. This property will be honored only if the
- DataNavigateUrlFields are not set. If either
- DataNavigateUrlFields are set, they will override the
- NavigateUrl property.
-
-
- A a string, specifying the url, to which to navigate,
- when a hyperlink within a column is pressed.
-
-
-
-
- Sets or gets a string, specifying the window or frame at which to target
- content. The possible values are:
- _blank - the target URL will open in a new window
- _self - the target URL will open in the same frame as it was clicked
- _parent - the target URL will open in the parent frameset
- _top - the target URL will open in the full body of the window
-
-
- A string, specifying the window or frame at which to
- target content.
-
-
-
-
- Gets or sets a string, specifying the text to be displayed by the hyperlinks in
- the column, when there is no DataTextField specified.
-
-
- A string, specifying the text to be displayed by the
- hyperlinks in the column, when there is no DataTextField specified.
-
-
-
-
- Gets or sets whether the column data can be filtered. The default value is
- true.
-
-
- A Boolean value, indicating whether the column can be
- filtered.
-
-
-
-
- Displays each item in the column in accordance with a specified templates (item,
- edit item, header and footer templates). This allows you to provide custom controls in
- the column.
-
- Grid column types
-
-
-
- Grid Column types
- Adding columns design-time
- Using columns
- Customizing with GridTemplateColumn
- Persisting CheckBox control state in GridTemplateColumn on Rebind
-
- You can view and set templates using the Edit Templates command in grid's
- Smart Tag.
- You can also create the template columns programmatically and bind the
- controls in the code-behind (see
- Programmatic creation of
- Telerik RadGrid).
- Note: Unlike other grid columns, GridTemplateColumn cannot
- be set as read-only.
-
- Programmatic creation
-
-
-
- Gets or sets a string, specifying which DataField from the data source the
- control will use to handle the automatic filtering.
-
-
- A string, specifying which DataField from the data
- source the control will use to handle the automatic filtering.
-
-
-
-
- Gets or sets whether the column data can be filtered. The default value is
- true.
-
-
- A Boolean value, indicating whether the column can be
- filtered.
-
-
-
-
- Gets or sets the field name from the specified data source to bind to the
- GridTemplateColumn.
-
-
- A string, specifying the data field from the data
- source, from which to bind the column.
-
-
-
-
- Gets or sets the ItemTemplate, which is rendered in the control in edit mode.
-
- A value of type ITemplate
-
-
-
- Gets or sets the template, which will be rendered in the footer of the template
- column.
-
- A value of type ITemplate.
-
-
-
- Gets or sets the template, which will be rendered in the header of the template
- column.
-
- A value of type ITemplate.
-
-
-
- Gets or sets the ItemTemplate, which is rendered in the control in normal
- (non-Edit) mode.
-
- A value of type ITemplate
-
-
-
- Gets a Boolean value, indicating whether the column is editable. If a template
- column is editable, it will render the contents of the EditItemTemplate in the edit
- form. If there are no contents in the EditItemTemplate, the column will not be
- editable.
-
-
- A Boolean value, indicating whether the column is
- editable.
-
-
-
-
- Set to false if templates should overwrite other controls in header cell (sort image, etc)
-
-
-
-
- Number of items in the group
-
-
-
-
- Number of items displayed on the page
-
-
-
-
- if true Group is countinued from the previous page or it continues
- on the next page if value of false
-
-
-
-
- Summary description for DataSetHelper.
-
-
-
-
- Summary description for DefaultValueChecker.
-
-
-
-
- Type of the edit forms in RadGrid
-
-
-
-
- Form is autogenerated, based on the column that each GridTableView exposes.
-
-
-
-
- The edit form is a WebUserControl specified by
-
-
-
-
- The template specified by is used as an edit form.
-
-
-
-
- Settings for the edit forms generated by a for each item that is in edit mode and the
- is set to .
-
-
- Set the type of the EditForm using .
- If the type is then the form will be autogenerated based on the
- columns of the corresponding table view. Note that only the columns that are editable wil be included. Those are
- the standatrd columns that have editing capabilities - such that has
- set to false. All the style properties apply only to the autogenerated edit form.
- See for more details on the types of the edit forms.
-
-
-
-
- Set properties of the update-cancel buttons column that appears in an edit form
-
-
-
-
- Number of vertical columns to split all edit fields on the form when it is autogenerated.
- Each GridColumn has a to choose the column where
- the editor would appear.
-
-
-
-
- Data field to incude in form's caption
-
-
-
-
- Caption format string - {0} parameter must be included and would be repaced with DataField value
-
-
-
-
- Caption for the pop-up insert form
-
-
-
-
- Style of the forms's area (rendered as a DIV elemet)
-
-
-
-
- Style of the forms' table element
-
-
-
-
- Style of the forms' main table element
-
-
-
-
- Style of the table row that shows the caption of the form
-
-
-
-
- Style of the normal rows in the edit-form's table
-
-
-
-
- Style of the alternating rows in the edit-form's table
-
-
-
-
- Style of the footer row of the table, where the update-cancel buttons appear
-
-
-
-
- Specifies the type of the edit form. See about details for
- the possible values and their meanings.
-
-
-
-
-
- EditForm template - if EditFormType if is of type .
-
-
-
-
- Gets a reference to class providing properties
- related to PopUp EditForm.
-
-
-
-
- Gets or sets a value specifying the grid height in pixels (px).
-
- the default value is 300px
-
-
-
- Gets or sets a value specifying the grid height in pixels (px).
-
- the default value is 400px
-
-
-
- Summary description for GridEditManager.
-
-
-
-
- Serves as the abstract base class for data tables. This class provides the
- methods and properties common to all tables in
- Telerik RadGrid.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
-
-
-
-
-
-
-
-
-
-
-
-
- Registers the control with the ScriptManager
-
-
-
-
- Registers the CSS references
-
-
-
-
- Loads the client state data
-
-
-
-
-
- Saves the client state data
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the names of all embedded skins. Used by Telerik.Web.Examples.
-
-
-
-
- Executed when post data is loaded from the request
-
-
-
-
-
-
-
- Executed when post data changes should invoke a chagned event
-
-
-
-
- Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
-
-
-
- If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.
-
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
-
-
- For internal use.
-
-
-
-
- Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
-
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
-
- Gets the real skin name for the control user interface. If Skin is not set, returns
- "Default", otherwise returns Skin.
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
-
-
-
-
-
- The CssClass property will now be used instead of the former Skin
- and will be modified in AddAttributesToRender()
-
-
- protected override string CssClassFormatString
- {
- get
- {
- return "RadDock RadDock_{0} rdWTitle rdWFooter";
- }
- }
-
-
-
-
-
-
-
-
-
-
-
-
- Occurs when a different item is selected in a table between posts to the
- server.
-
-
-
- Gets or sets the tab index of the Web server control.
-
-
-
- Gets or sets the amount of space between the contents of a cell and the cell's
- border.
-
-
-
- Gets or sets the amount of space between cells.
-
-
-
-
-
-
-
- Gets or sets a value that specifies whether the border between the cells of a
- data table is displayed.
-
-
-
-
- Gets or sets the horizontal alignment of a data table within its
- container.
-
-
-
-
- This event is fired when the grid request data using client-side data-binding.
-
-
-
-
- This event is fired if request for data fails when using client-side data-binding.
-
-
-
-
- This event is fired when the grid client-side data is retrieved from the server.
-
-
-
-
- This event is fired when the grid client-side data-binding is finished.
-
-
-
-
- This event is fired before grid creation.
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnGridCreating="GridCreating" ...
-
- JavaScript
- <script>
-
- function
- GridCreating()
- {
- alert("Creting grid with ClientID: " + this.ClientID);
- }
- </script>
-
- This client-side event is fired before grid creation.
-
-
-
- This event is fired after the grid is created.
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnGridCreated="GridCreated" ...
-
- JavaScript
- <script>
- function GridCreated()
- {
- alert("Grid with ClientID: " + this.ClientID + " was created");
- }
- </script>
-
- This client-side event is fired after the grid is created.
-
-
-
- This event is fired when RadGrid object is destroyed, i.e. on each
- window.onunload
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnGridCreating="GridDestroying" ...
-
- JavaScript
- <script>
- function
- GridDestroying()
- {
- alert("Destroying grid with ClientID: " + this.ClientID);
- }
- </script>
-
-
- This client-side event is fired when RadGrid object is
- destroyed, i.e. on each window.onunload
-
-
-
-
- This event is fired before the MasterTableView is created.
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnMasterTableViewCreating="MasterTableViewCreating" ...
-
- JavaScript
- <script>
- function
- MasterTableViewCreating()
- {
- alert("Creating MasterTableView");
- }
- </script>
-
- This client-side event is fired before the MasterTableView is created.
-
-
-
- This event is fired after the MasterTableView is created.
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnMasterTableViewCreated="MasterTableViewCreated" ...
-
- JavaScript
- <script>
- function
- MasterTableViewCreated()
- {
- alert("MasterTableView was created");
- }
- </script>
-
- This client-side event is fired after the MasterTableView is created.
-
-
-
- This event is fired before table creation.
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnTableCreating="TableCreating" ...
-
- JavaScript
- <script>
- function
- TableCreating()
- {
- alert("Creating DetailTable");
- }
- </script>
-
- This client-side event is fired before table creation.
-
-
-
- This event is fired after the table is created.
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- RadGridTable Object
-
-
- Can be canceled
- No
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnTableCreated="TableCreated" ...
-
- JavaScript
- <script>
- function
- TableCreated(tableObject)
- {
- alert("DetailTable with ClientID: " + tableObject.ClientID + " was
- created");
- }
- </script>
-
- This client-side event is fired after the table is created.
-
-
-
- This event is fired when table object is destroyed.
-
-
-
- Fired by
- RadGrid
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnTableDestroying="TableDestroying" ...
-
- JavaScript
- <script>
- function
- TableDestroying()
- {
- alert("Destroing DetailTable with ClientID: " + this.ClientID);
- }
- </script>
-
- This client-side event is fired when table object is destroyed.
-
-
-
- This event is fired before column available at client-side creation.
-
-
-
- Fired by
- RadGridTable
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnColumnCreating="ColumnCreating" ...
-
- JavaScript
- <script>
- function
- ColumnCreating()
- {
- alert("Creating column);
- }
- </script>
-
-
- This client-side event is fired before column available at client-side
- creation.
-
-
-
-
- This event is fired after a column available at client-side is created.
-
-
-
- Fired by
- RadGridTable
-
-
- Arguments
- RadGridTableColumn object
-
-
- Can be canceled
- No
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnColumnCreated="ColumnCreated" ...
-
- JavaScript
- <script>
- function
- ColumnCreated(columnObject)
- {
- alert("Column with Index: " + columnObject.Index + " was created");
- }
- </script>
-
-
- This client-side event is fired after a column available at client-side is
- created.
-
-
-
-
- This event is fired when a column object is destroyed.
-
-
-
- Fired by
- RadGridTable
-
-
- Arguments
- N/A
-
-
- Can be canceled
- No
-
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnColumnDestroying="ColumnDestroying" ...
-
- JavaScript
- <script>
- function
- ColumnDestroying()
- {
- alert("Destroing column with Index: " + this.Index);
- }
- </script>
-
- This client-side event is fired when a column object is destroyed.
-
-
-
- This event is fired before a column is resized.
-
-
-
- Fired by
- RadGridTable
-
-
- Arguments
- columnIndex, columnWidth
-
-
- Can be canceled
- Yes, return false to cancel
-
-
- Examples
-
-
- ascx/aspx
- <ClientEvents
- OnColumnResizing="ColumnResizing" ...
-
- JavaScript
- <script>
- function
- ColumnResizing(columnIndex, columnWidth)
- {
- alert("Resizng column with Index: " + columnIndex + ", width: " +
- columnWidth);
- }
- OR
- function
- ColumnResizing(columnIndex, columnWidth)
- {
- return false; //cancel ColumnResizing event
- }
- </script>
-
- This client-side event is fired before a column is resized.
-
-
- FOR FUTURE VERSIONS
-
-
-
- The client-side script
- for RadGrid.ClientSettings.ClientEvents.OnRowContextMenu kills any exceptions that
- occur in the event handler. This can make bugs hard to track down because it
- appears that nothing happens when actually the exception was killed before it
- becomes visible.
- You can avoid this problem by putting a try/catch block around the
- event handler that sends an alert if an exception was thrown:
-
-
-
-
-
- Contains properties related to messages appearing as tooltips for various grid
- actions. You can use this class for localizing the grid messages.
-
-
-
-
- Gets or sets a string that will be displayed as a tooltip when you start dragging
- a column header trying to reorder columns.
-
-
- string, the tooltip that will be displayed when you try to
- reorder columns. By default it states "Drop here to reorder".
-
-
-
-
- Gets or sets a string that will be displayed as a tooltip when you hover a column
- that can be dragged.
-
-
- string, the tooltip that will be displayed hover a draggable
- column. By default it states "Drag to group or reorder".
-
-
-
-
- string, the tooltip that will be displayed when you hover the
- resizing handle of a column. By default it states "Drag to
- resize".
-
-
- Gets or sets a string that will be displayed as a tooltip when you hover the
- resizing handle of a column.
-
-
-
-
- The format string used for the tooltip when using Ajax scroll paging or the Slider pager
-
-
-
-
- The format string used for the tooltip when resizing a column
-
-
-
- This method is for Telerik RadGrid internal usage.
-
- Checks if a client settings property value was changed and differs from its
- default.
-
-
-
-
- Gets a reference to class providing properties
- related to client-side selection features.
-
-
-
-
- Gets a reference to class providing properties
- related to client-side selection features.
-
-
-
- Gets a reference to class.
-
-
-
- Gets a reference to class, holding properties
- that can be used for localizing Telerik RadGrid.
-
-
-
-
- Gets a reference to class, holding properties
- related to RadGrid keyboard navigation.
-
-
-
-
- Gets a reference to , which holds various
- properties for setting the Telerik RadGrid scrolling features.
-
-
-
-
- Gets a reference to , which holds properties related
- to Telerik RadGrid resizing features.
-
-
-
-
- Determines whether the alternating items will render with a different CSS class.
-
-
-
-
- Gets or sets a value indicating whether the keyboard navigation will be enabled
- in Telerik RadGrid.
-
-
- true, if keyboard navigation is enabled, otherwise false (the default
- value).
-
-
-
-
Arrowkey Navigation - allows end-users to navigate around
- the menu structure using the arrow keys.
-
select grid items pressing the [SPACE] key
-
edit rows hitting the [ENTER] key
-
-
-
-
-
- Gets or sets a value indicating whether you will be able to drag column headers to
- and let the grid automatically form
- and group its data.
-
-
- true, if you are able to drag group header to the group panel,
- otherwise false (the default value)
-
-
-
-
- Gets or sets a value indicating whether you will be able to reorder columns by
- using drag&drop. By default it is false.
-
- ReorderColumnsOnClient Property
-
- true if reorder via drag&drop is enabled, otherwise
- false (the default value).
-
-
-
-
- Gets or sets a value indicating whether MasterTableView will be automatically scrolled when an item is dragged.
-
-
-
-
- Gets or sets a value indicating whether columns will be reordered on the client.
- This property is meaningful when used in conjunction with
- set to true.
-
-
- False by default, which means that each time you try to reorder columns a
- postback will be performed.
- Note that in case this property is true the order changes will be persisted
- on the server only after postback.
-
-
- true if columns are reordered on the client, otherwise
- false (the default value.
-
-
-
-
- Gets or sets a value indicating whether the expand/collapse functionality for
- hierarchical structures in grid will be enabled.
- The AllowExpandCollapse property of RadGrid is meaningful with client
- hierarchy load mode only and determine
- whether the end user will be able to expand/collapse grid items. This property do
- not control the visibility of the corresponding expand/collapse column.
-
-
- This property should be set to true, when working in
- HierarchyLoadMode.Client.
-
-
- true if expand/collapse is enabled, otherwise
- false (the default value).
-
-
-
-
- Gets or sets a value indicating whether the expand/collapse functionality for
- grouped data in grid will be enabled.
- The AllowGroupExpandCollapse property of RadGrid is meaningful with client
- group load mode only and determine whether the end user will be able to
- expand/collapse grid items. This property do not control the visibility of the
- corresponding expand/collapse column.
-
-
- true, if expand/collapse is enabled, otherwise
- false (the default value).
-
-
-
-
- Gets or sets a value indicating whether
- event will be canceled.
-
-
- true, if the event is canceled, otherwise
- false.
-
-
-
-
- Interface that provides the basic functionality needed for a class to be used to
- send information to Command event handler.
-
-
-
- Override to fire the corresponding command.
-
-
- Gets or sets a value, defining whether the command should be canceled.
-
-
- For internal usage only.
-
-
-
- For internal usage only.
-
-
-
- Represents the method that will handle grid's Command events including
- CancelCommand, DeleteCommand, EditCommand, InsertCommand, ItemCommand, SortCommand and
- UpdateCommand.
-
- The source of the event.
- A object that contains the event data.
-
-
-
- Provides data for Command events including CancelCommand, DeleteCommand,
- EditCommand, InsertCommand, ItemCommand, SortCommand and UpdateCommand.
-
-
-
-
- Fires the command stored in
- property
-
-
-
- Gets the source of the command
-
-
- // Get a reference to the control that triggered expand/collapse command
- protected void RadGrid1_ItemCommand(object source, GridCommandEventArgs e)
- {
- if (e.CommandName == RadGrid.ExpandCollapseCommandName)
- {
- Control c = e.CommandSource as Control;
- }
- }
-
-
- ' Get a reference to the control that triggered expand/collapse command
- Protected Sub RadGrid1_ItemCommand([source] As Object, e As GridCommandEventArgs)
- If e.CommandName = RadGrid.ExpandCollapseCommandName Then
- Dim c As Control = e.CommandSource
- End If
- End Sub 'RadGrid1_ItemCommand
-
-
-
-
- Gets the item containing the command source
-
-
- protected void RadGrid1_UpdateCommand(object source, GridCommandEventArgs e)
- {
- if (e.Item is GridEditFormItem && e.Item.IsInEditMode)
- {
- GridEditFormItem item = e.Item as GridEditFormItem;
- Hashtable newValues = new Hashtable();
- item.OwnerTableView.ExtractValuesFromItem(newValues, item);
- if (newValues["Name"].ToString() == "DefaultName")
- {
- e.Canceled = true;
- }
- }
- }
-
-
- Protected Sub RadGrid1_UpdateCommand([source] As Object, e As GridCommandEventArgs)
- If Typeof e.Item Is GridEditFormItem AndAlso e.Item.IsInEditMode Then
- Dim item As GridEditFormItem = e.Item
- Dim newValues As New Hashtable()
- item.OwnerTableView.ExtractValuesFromItem(newValues, item)
- If newValues("Name").ToString() = "DefaultName" Then
- e.Canceled = True
- End If
- End If
- End Sub
-
-
-
-
- Gets or sets a value, defining whether the command should be canceled.
-
-
- protected void RadGrid1_UpdateCommand(object source, GridCommandEventArgs e)
- {
- if (e.Item is GridEditFormItem && e.Item.IsInEditMode)
- {
- GridEditFormItem item = e.Item as GridEditFormItem;
- Hashtable newValues = new Hashtable();
- item.OwnerTableView.ExtractValuesFromItem(newValues, item);
- if (newValues["Name"].ToString() == "DefaultName")
- {
- e.Canceled = true;
- }
- }
- }
-
-
- Protected Sub RadGrid1_UpdateCommand([source] As Object, e As GridCommandEventArgs)
- If Typeof e.Item Is GridEditFormItem AndAlso e.Item.IsInEditMode Then
- Dim item As GridEditFormItem = e.Item
- Dim newValues As New Hashtable()
- item.OwnerTableView.ExtractValuesFromItem(newValues, item)
- If newValues("Name").ToString() = "DefaultName" Then
- e.Canceled = True
- End If
- End If
- End Sub
-
-
-
-
- For internal usage only.
-
-
-
- Fires RadGrid.SelectedIndexChanged event.
-
-
- For internal usage only
-
-
-
- Fires RadGrid.SelectedIndexChanged event.
-
-
- Represents a method that will handle grid's DetailTableDataBind event.
-
-
- Provides data for DetailTableDataBind event.
-
-
- protected void RadGrid1_DetailTableDataBind(object source, Telerik.Web.UI.GridDetailTableDataBindEventArgs e)
- {
- GridDataItem parentItem = e.DetailTableView.ParentItem as GridDataItem;
- if (e.DetailTableView.DataSourceID == "AccessDataSource2")
- {
- Session["CustomerID"] = parentItem["CustomerID"].Text;
- }
- }
-
-
- Protected Sub RadGrid1_DetailTableDataBind(ByVal source As Object, ByVal e As GridDetailTableDataBindEventArgs) Handles RadGrid1.DetailTableDataBind
- Dim parentItem As GridDataItem = CType(e.DetailTableView.ParentItem, GridDataItem)
- If (e.DetailTableView.DataSourceID = "AccessDataSource2") Then
- Session("CustomerID") = parentItem("CustomerID").Text
- End If
- End Sub
-
-
-
-
-
- Fires RadGrid.DetailTableDataBind event
-
-
-
-
- Gets a reference to the detail table being bound.
-
-
- protected void RadGrid1_DetailTableDataBind(object source, Telerik.Web.UI.GridDetailTableDataBindEventArgs e)
- {
- GridDataItem parentItem = e.DetailTableView.ParentItem as GridDataItem;
- if (e.DetailTableView.DataSourceID == "AccessDataSource2")
- {
- Session["CustomerID"] = parentItem["CustomerID"].Text;
- }
- }
-
-
- Protected Sub RadGrid1_DetailTableDataBind(ByVal source As Object, ByVal e As GridDetailTableDataBindEventArgs) Handles RadGrid1.DetailTableDataBind
- Dim parentItem As GridDataItem = CType(e.DetailTableView.ParentItem, GridDataItem)
- If (e.DetailTableView.DataSourceID = "AccessDataSource2") Then
- Session("CustomerID") = parentItem("CustomerID").Text
- End If
- End Sub
-
-
-
-
- Gets or sets a value, defining whether the command should be canceled.
-
-
- For internal usage only.
-
-
-
-
- Expands/Collapses the containing the
-
-
-
-
- For internal usage only.
-
-
-
-
- Calculates and sets the to the corresponding
- and rebinds the grid.
-
-
-
- For internal usage only.
-
-
-
-
- A collection that stores objects. You can access
- this collection through property of a
- parent .
-
-
-
-
-
-
- Initializes a new instance of .
-
-
- that would aggregate this instance
-
-
-
-
- Initializes a new instance of based on another .
-
-
-
- A from which the contents are copied
-
-
-
-
-
- Initializes a new instance of containing any array of objects.
-
-
-
- An array of objects with which to intialize the collection
-
-
-
-
- Adds a with the specified value to the
- .
-
- The to add.
-
- The index at which the new element was inserted.
-
-
-
-
-
- Copies the elements of an array to the end of the .
-
-
- An array of type containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
-
- Adds the contents of another to the end of the collection.
-
-
-
- A containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
- Gets a value indicating whether the
- contains the specified .
-
- The to locate.
-
- if the is contained in the collection;
- otherwise, .
-
-
-
-
-
- Copies the values to a one-dimensional instance at the
- specified index.
-
- The one-dimensional that is the destination of the values copied from .
- The index in where copying begins.
-
- None.
-
- is multidimensional.-or-The number of elements in the is greater than the available space between and the end of .
- is .
- is less than "s lowbound.
-
-
-
-
- Returns the index of a in
- the .
-
- The to locate.
-
- The index of the of in the
- , if found; otherwise, -1.
-
-
-
-
-
- Inserts a into the at the specified index.
-
- The zero-based index where should be inserted.
- The to insert.
- None.
-
-
-
-
- Returns an enumerator that can iterate through
- the .
-
- None.
-
-
-
-
- Removes a specific from the
- .
-
- The to remove from the .
- None.
- is not found in the Collection.
-
-
-
- Get the instance of that owns this instance
-
-
-
-
- Represents the entry at the specified index of the .
-
- The zero-based index of the entry to locate in the collection.
-
- The entry at the specified index of the collection.
-
- is outside the valid range of indexes for the collection.
-
-
-
- Add DataColumns for grid columns with composite DataFields (sub properties)
-
-
-
-
- Summary description for IGridEnumerable.
-
-
-
-
- Container of misc. grouping settings of RadGrid control
-
-
-
-
- A string specifying the name (without the extension) of the file that will be
- created. The file extension is automatically added based on the method that is
- used.
-
- Export Grid to Microsoft Excel, Microsoft Word
-
-
- Determines whether only data will be exported.
- Export Grid to Microsoft Excel, Microsoft Word
-
-
- Determines whether the structure columns (the row indicator and the expand/collapse columns) will be exported.
-
-
-
- Specifies whether all records will be exported or merely those on the current
- page.
-
- Export Grid to Microsoft Excel, Microsoft Word
-
-
- Opens the exported grid in a new instead of the same page.
- Export Grid to Microsoft Excel, Microsoft Word
-
-
-
- Container of misc. grouping settings of RadGrid control
-
-
-
-
- Gets or sets the row delimiter for RadGrid CSV export.
-
-
-
-
- Gets or sets the row delimiter for RadGrid CSV export.
-
-
-
-
- Predefined filter expression enumeration. Used by class.
-
- Basic Filtering
-
- Some functions are applicable (and are not displayed on filterting) to all
- the data types:
- String type supports all the functions.
- Integer: NoFilter, EqualTo, NotEqualTo, GreaterThan,
- LessThan, GreaterThanOrEqualTo, LessThanOrEqualTo, Between, NotBetween, IsNull and
- NotIsNull are supported. Contains, DoesNotContain,
- StartsWith,
- EndsWith, IsEmpty and
- NotIsEmpty
- are not supported.
- Date: same as Integer.
-
- Basic Filtering
- How-To: Localizing filtering menu options
- How-To: Reducing filtering menu options
-
-
-
- No filter would be applied, filter controls would be cleared
-
-
-
- Same as: dataField LIKE '/%value/%'
-
-
- Same as: dataField NOT LIKE '/%value/%'
-
-
- Same as: dataField LIKE 'value/%'
-
-
- Same as: dataField LIKE '/%value'
-
-
-
- Same as: dataField = value
-
-
-
- Same as: dataField != value
-
-
- Same as: dataField > value
-
-
-
- Same as: dataField < value
-
-
-
- Same as: dataField >= value
-
-
-
- Same as: dataField <= value
-
-
-
-
- Same as: value1 <= dataField <= value2.
- Note that value1 and value2 should be separated by [space] when entered as
- filter.
-
-
-
-
- Same as: dataField <= value1 && dataField >= value2.
- Note that value1 and value2 should be separated by [space] when entered as
- filter.
-
-
-
-
- Same as: dataField = ''
-
-
-
- Same as: dataField != ''
-
-
-
- Only null values
-
-
-
-
- Only those records that does not contain null values within the corresponding column
-
-
-
-
- Custom function will be applied. The filter value should contain a valid filter expression, including DataField, operators and value
-
-
-
-
- Choose which filter function will be enabled for a column
-
- Basic Filtering
- Custom option for filtering (FilterListOptions ->
- VaryByDataTypeAllowCustom)
-
-
-
- Depending of data type of the column, RadGrid will automatically choose which filters to be displayed in the list
-
-
-
-
- As VaryByDataType with custom filtering enabled
-
-
-
-
- All filters will be displayed. Note that some data types are not applicatble to some filter functions. For example you cannot apply
- the 'like' function for integer data type. In such cases you should handle the filtering in a custom manner, handling
- for 'Filter' command or
-
-
-
-
- Used when column-based filtering feature of RadGrid is enabled. Defines properties and methods for formatting the
- predefined filter expressions
-
-
-
-
- Enumeration representing the aggregate functions which can be applied to a
- GridGroupByField (part of
- collection)
-
-
- Meaningful only when GridGroupByField is part of
- collection
-
- Programmatic GridGroupByField syntax
-
-
- GridGroupByField gridGroupByField;
-
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "Freight";
- gridGroupByField.HeaderText = "Total shipping cost is ";
- gridGroupByField.Aggregate = GridAggregateFunction.Sum;
- expression.SelectFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- gridGroupByField = New GridGroupByField
- gridGroupByField.FieldName = "Freight"
- gridGroupByField.HeaderText = "Total shipping cost is "
- gridGroupByField.Aggregate = GridAggregateFunction.Sum
- expression.SelectFields.Add(gridGroupByField)
-
-
-
-
-
- Field which is part of each
- and collection
-
-
-
- Dim groupExpression As GridGroupByExpression = New GridGroupByExpression()
-
- Dim groupByField As GridGroupByField = New GridGroupByField()
-
- groupByField = New GridGroupByField()
- groupByField.FieldName = "Received"
- groupExpression.SelectFields.Add(groupByField)
-
- groupByField = New GridGroupByField()
- groupByField.FieldName = "Received"
- groupExpression.GroupByFields.Add(groupByField)
-
- RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression)
-
-
- GridGroupByExpression groupExpression = new GridGroupByExpression();
-
- GridGroupByField groupByField = new GridGroupByField();
- groupByField = new GridGroupByField();
- groupByField.FieldName = "Received";
- groupExpression.SelectFields.Add(groupByField);
-
- groupByField = new GridGroupByField();
- groupByField.FieldName = "Received";
- groupExpression.GroupByFields.Add(groupByField);
-
- RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression);
-
-
-
- Some of the GridGroupByField properties are meaningful only when present under
- specific collection - or
-
-
- Declarative GridGroupByField syntax
- Programmatic GridGroupByField syntax
-
-
-
- Method setting the aggregate function applied for a
- GridGroupByField which is part of the
- collection.
-
- N/A
-
-
- Dim groupExpression As GridGroupByExpression = New GridGroupByExpression()
-
- Dim groupByField As GridGroupByField = New GridGroupByField()
- groupByField.FieldName = "Size"
- groupByField.SetAggregate(GridAggregateFunction.Sum)
- groupExpression.SelectFields.Add(groupByField)
-
- groupByField = New GridGroupByField()
- groupByField.FieldName = "Received"
- groupExpression.SelectFields.Add(groupByField)
-
- groupByField = New GridGroupByField()
- groupByField.FieldName = "Received"
- groupExpression.GroupByFields.Add(groupByField)
-
- RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression)
-
-
- GridGroupByExpression groupExpression = new GridGroupByExpression();
-
- GridGroupByField groupByField = new GridGroupByField();
- groupByField.FieldName = "Size";
- groupByField.SetAggregate(GridAggregateFunction.Sum);
- groupExpression.SelectFields.Add(groupByField);
-
- groupByField = new GridGroupByField();
- groupByField.FieldName = "Received";
- groupExpression.SelectFields.Add(groupByField);
-
- groupByField = new GridGroupByField();
- groupByField.FieldName = "Received";
- groupExpression.GroupByFields.Add(groupByField);
-
- RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression);
-
-
-
- Meaningful only for GridGroupByFields from the
- collection
-
-
-
-
- Method setting the sort order applied for a GridGroupByField which
- is part of the collection.
-
- N/A
-
- Meaningful only for GridGroupByFields from the
- collection
-
-
-
- GridGroupByExpression groupExpression = new GridGroupByExpression();
-
- groupByField = new GridGroupByField();
- groupByField.FieldName = "Received";
- groupExpression.SelectFields.Add(groupByField);
-
- groupByField = new GridGroupByField();
- groupByField.FieldName = "Received";
- groupByField.SetSortOrder(GridSortOrder.Ascending);
- groupExpression.GroupByFields.Add(groupByField);
-
- RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression);
-
-
- Dim groupExpression As GridGroupByExpression = New GridGroupByExpression()
-
- Dim groupByField As GridGroupByField = New GridGroupByField()
-
- groupByField = New GridGroupByField()
- groupByField.FieldName = "Received"
- groupExpression.SelectFields.Add(groupByField)
-
- groupByField = New GridGroupByField()
- groupByField.FieldName = "Received"
- groupByField.SetSortOrder(GridSortOrder.Descending)
- groupExpression.GroupByFields.Add(groupByField)
-
- RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression)
-
-
-
-
-
- Method which gets the HeaderText value from GridGroupByField part
- of the collection
-
- String containing the HeaderText value
-
- Meaningful only for GridGroupByFields from the
- collection
-
-
-
- Dim groupExpression As GridGroupByExpression = RadGrid1.MasterTableView.GroupByExpressions(0)
- Dim headerText as String = groupExpression.SelectFields(0).GetHeaderText()
-
-
- GridGroupByExpression groupExpression = RadGrid1.MasterTableView.GroupByExpressions[0] as GridGroupByExpression;
- String headerText = groupExpression.SelectFields[0].GetHeaderText()
-
-
-
-
-
- Method which gets the FormatString value from GridGroupByField
- part of the collection
-
- String containing the FormatString value
-
- Meaningful only for GridGroupByFields from the
- collection
-
-
-
- Dim groupExpression As GridGroupByExpression = RadGrid1.MasterTableView.GroupByExpressions(0)
- Dim formatString As String = groupExpression.SelectFields(0).GetFormatString()
-
-
- GridGroupByExpression groupExpression = RadGrid1.MasterTableView.GroupByExpressions[0] As GridGroupByExpression;
- String formatString = groupExpression.SelectFields[0].GetFormatString()
-
-
-
-
- Inherited but not used
-
-
-
- Method that retrieves a System.String that indicates the current
- object
-
- The string format of the object.
- Object.ToString()
-
-
- Inherited but not used
-
-
-
- Gets or sets a string that represents the DataField column
- property that will be used to form the GroupByExpression.
-
-
- Unless you have specified a FieldAlias, the value of this
- property will be used when Telerik RadGrid constructs the text for
- GridGroupHeaderItem. FieldName has a meaning both for
- SelectFields and GroupByFields of
- GroupByExpression.
-
-
- String representing the DataField for the corresponding grouped
- column
-
-
-
- GridGroupByField gridGroupByField;
-
- //Add select fields (before the "Group By" clause)
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "EmployeeID";
- gridGroupByField.HeaderText = "Employee";
- expression.SelectFields.Add( gridGroupByField );
-
- //Add a field for group-by (after the "Group By" clause)
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "EmployeeID";
- expression.GroupByFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- 'Add select field (before the "Group By" clause)
- gridGroupByField = New GridGroupByField()
- gridGroupByField.FieldName = "EmployeeID"
- gridGroupByField.HeaderText = "Employee"
- expression.SelectFields.Add(gridGroupByField)
-
- 'Add a field for group-by (after the "Group By" clause)
- gridGroupByField = New GridGroupByField()
- gridGroupByField.FieldName = "EmployeeID"
- expression.GroupByFields.Add(gridGroupByField)
-
-
- Declarative GridGroupByField syntax
- Programmatic GridGroupByField syntax
-
-
-
- Gets or sets a value representing a friendly name for the field used for forming
- the group by expression. This name will be displayed in each group header when grouping
- by the respective field.
-
-
-
- Use this property for setting the field text that will be displayed in the
- GridGroupHeaderItem. If this property is not set, the value of
- property will be used. Note that this property has
- a meaning only for GridGroupByField part of the SelectFields of
- GridGroupByExpression.
-
- This property is useful in cases when:
-
- you want to change the value displayed in group header (different than
- the default DataField column value)
- or
- group by a template column and Telerik RadGrid cannot get the
- header text for that column.
-
-
-
-
- GridGroupByField gridGroupByField;
-
- //Add select fields (before the "Group By" clause)
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "EmployeeID";
- gridGroupByField.FieldAlias = "EmployeeIdentificator";
- expression.SelectFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- 'Add select fields (before the "Group By" clause)
- gridGroupByField = New GridGroupByField
- gridGroupByField.FieldName = "EmployeeID"
- gridGroupByField.FieldAlias = "EmployeeIdentificator"
- expression.SelectFields.Add(gridGroupByField)
-
-
- String representing the friendly name shown
- Declarative GridGroupByField syntax
- Programmatic GridGroupByField syntax
-
-
-
- Meaningful only for fields in the
- collection.
-
-
- Gets or sets aggregate function (from
- enumeration values) that will be applied on the grouped data.
-
-
- Returns the result from currently used aggregate function. This property defaults
- to GridAggregateFunction.None
-
-
-
- GridGroupByField gridGroupByField;
-
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "Freight";
- gridGroupByField.HeaderText = "Total shipping cost is ";
- gridGroupByField.Aggregate = GridAggregateFunction.Sum;
- expression.SelectFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- gridGroupByField = New GridGroupByField
- gridGroupByField.FieldName = "Freight"
- gridGroupByField.HeaderText = "Total shipping cost is "
- gridGroupByField.Aggregate = GridAggregateFunction.Sum
- expression.SelectFields.Add(gridGroupByField)
-
-
- Programmatic GridGroupByField syntax
-
-
-
- Meaningful only for fields in the
- collection. 'None' value is
- not supported because it can not determine uniquely the order in which the groups
- will be displayed.
-
-
- Gets or sets the value representing how the data will be sorted. Acceptable values
- are the values of enumeration except for None
- (Ascending, Descending).
-
-
- Returns the sorting mode applied to the grouped data. By default it is
- Ascending.
-
-
-
- GridGroupByField gridGroupByField;
-
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "EmployeeID";
- gridGroupByField.SortOrder = GridSortOrder.Descending;
- expression.GroupByFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- gridGroupByField = New GridGroupByField
- gridGroupByField.FieldName = "EmployeeID"
- gridGroupByField.SortOrder = GridSortOrder.Descending
- expression.GroupByFields.Add(gridGroupByField)
-
-
- Programmatic GridGroupByField syntax
-
-
-
-
- Meaningful only for fields in the
- collection.
-
- When rendering RadGrid is using this expression to format field's value. It
- is mandatory that {0} parameter is specified in the string - it will be replaced
- with field's runtime value.
-
-
- Gets or sets the string that will be used to format the GridGroupByField part of
- the collection.
-
-
- String, formated by the GridGroupByField's FormatString property. It defaults to:
- "{0}".
-
-
-
- GridGroupByField gridGroupByField;
-
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "EmployeeID";
- gridGroupByField.FormatString = "<strong>{0}</strong>";
- expression.SelectFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- gridGroupByField = New GridGroupByField
- gridGroupByField.FieldName = "EmployeeID"
- gridGroupByField.FormatString = "<strong>{0}</strong>"
- expression.SelectFields.Add(gridGroupByField)
-
-
- Declarative GridGroupByField syntax
- Programmatic GridGroupByField syntax
-
-
-
- Meaningful only for fields in the
- collection. When rendering
- RadGrid will override the FieldAlias value with the
- HeaderText specified.
-
-
- string, copied from the column's HeaderText if this group
- expression is based on a column. It defaults to the FieldAlias value
- (if specified).
-
-
- Gets or sets the expression that will be displayed in the
- .
-
-
-
- GridGroupByField gridGroupByField;
-
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "EmployeeID";
- gridGroupByField.HeaderText = "EmployeeNo";
- expression.SelectFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- gridGroupByField = New GridGroupByField
- gridGroupByField.FieldName = "EmployeeID"
- gridGroupByField.HeaderText = "EmployeeNo"
- expression.SelectFields.Add(gridGroupByField)
-
-
- Programmatic GridGroupByField syntax
-
-
-
- Gets or sets the string that separates header text from value text as the
- field is rendered in the GroupHeaderItems.
-
-
- string, represents the separator between the header text and value
- text.
- This field value defaults to ": ".
-
-
-
- GridGroupByField gridGroupByField;
-
- gridGroupByField = new GridGroupByField();
- gridGroupByField.FieldName = "EmployeeID";
- gridGroupByField.HeaderValueSeparator = " for current group: ";
- expression.SelectFields.Add( gridGroupByField );
-
-
- Dim gridGroupByField As GridGroupByField
-
- gridGroupByField = New GridGroupByField
- gridGroupByField.FieldName = "EmployeeID"
- gridGroupByField.HeaderValueSeparator = " for current group: "
- expression.SelectFields.Add(gridGroupByField)
-
-
-
- Meaningful only for fields in the
- collection.
-
- Programmatic GridGroupByField syntax
- Declarative GridGroupByField syntax
-
-
-
-
-
-
- Container of miscellaneous grouping settings of RadGrid control
-
-
- For internal usage only
-
-
-
- The group header message, indicating that the group continues on the next
- page.
-
- Localizing the grid messages
-
- Localizing the grid messages topic lists all the tooltips and text messages which
- can be modified.
-
-
-
- <GroupingSettings GroupContinuesFormatString="The group continues on the next page." />
-
-
-
-
-
- The group header message indicating that this group continues from the previous
- page.
-
- Localizing the grid messages
-
- Localizing the grid messages topic lists all the tooltips and text messages which
- can be modified.
-
-
-
- <GroupingSettings GroupContinuedFormatString="This group continues from the previous page." />
-
-
-
-
-
- A part of the string that formats the information label that appears on each
- group header of a group that is split onto several pages parameter {0} will be replaced
- with the number of actual items displayed on the page parameter {1} will be replaced
- with the number of all items in the group
-
-
-
-
- Gets or sets the format string that will be used when group is split, containing
- the GroupSplitDisplayFormat or
- GroupContinuedFormatString and
- GroupContinuesFormatString or the three together.
-
- This property defaults to "({0})"
-
-
-
- String that separates each group-by field when displayed in
- GridGroupHeaderItems.
-
- This property default to ";"
-
-
-
- Gets or sets a value indicating whether the grouping operations will be case
- sensitive or not.
-
-
- true if grouping is case sensitive, otherwise
- false. The default value is true.
-
-
-
-
- Gets or sets a string that will be displayed when the group expand image is
- hovered.
-
- Localizing the grid messages
-
- Localizing the grid messages topic lists all the tooltips and text messages which
- can be modified.
-
-
-
- <GroupingSettings ExpandTooltip="Click here to expand the group!" />
-
-
-
-
-
- Gets or sets a string that will be displayed when the group collapse image is
- hovered.
-
- Localizing the grid messages
-
- Localizing the grid messages topic lists all the tooltips and text messages which
- can be modified.
-
-
-
- <GroupingSettings ExpandTooltip="Click here to collapse the group!" />
-
-
-
-
-
- Gets or sets a string that will be displayed when a group panel item is
- hovered.
-
- Localizing the grid messages
-
- Localizing the grid messages topic lists all the tooltips and text messages which
- can be modified.
-
-
-
-
-
-
-
- Gets or sets value text of group panel item's ungroup button's tooltip
-
-
-
-
- Gets or sets value indicating if group panel item's ungroup button should be shown
-
-
-
-
- Gets or sets a value indicating whether the group footers should be kept visible
- when their parent group headers are collapsed.
-
-
-
-
- Holds properties specific for grouping mechanism such as performed action and
- reference to GridTableView where the action was performed.
-
-
-
-
- Gets a reference to enumeration, which
- holds information about what action did fire the
- event.
-
-
- protected void RadGrid1_GroupsChanging(object source,
- Telerik.Web.UI.GridGroupsChangingEventArgs e)
- {
- if (e.Action == GridGroupsChangingAction.Group)
- { ... }
-
-
-
-
- Gets a reference to the GridTableView object where the grouping
- is performed.
-
- a reference to GridTableView object.
-
-
-
- Gets or sets the that will be used for
- grouping Telerik RadGrid.
-
-
-
- protected void RadGrid1_GroupsChanging(object source, Telerik.Web.UI.GridGroupsChangingEventArgs e)
- {
- if (e.Action == GridGroupsChangingAction.Group)
- {
- GridGroupByField countryGroupField = new GridGroupByField();
- countryGroupField.FieldName = "Country";
- GridGroupByField cityGroupField = new GridGroupByField();
- cityGroupField.FieldName = "City";
-
- e.Expression.SelectFields.Clear();
- e.Expression.SelectFields.Add(countryGroupField);
- e.Expression.SelectFields.Add(cityGroupField);
-
- e.Expression.GroupByFields.Clear();
- e.Expression.GroupByFields.Add(countryGroupField);
- e.Expression.GroupByFields.Add(cityGroupField);
- ...
- }
- }
-
-
- Protected Sub RadGrid1_GroupsChanging(ByVal source As Object, ByVal e As Telerik.Web.UI.GridGroupsChangingEventArgs)
- 'Expression is added (by drag/grop on group panel)
- If (e.Action = GridGroupsChangingAction.Group) Then
- Dim countryGroupField As GridGroupByField = New GridGroupByField
- countryGroupField.FieldName = "Country"
- Dim cityGroupField As GridGroupByField = New GridGroupByField
- cityGroupField.FieldName = "City"
- e.Expression.SelectFields.Clear
- e.Expression.SelectFields.Add(countryGroupField)
- e.Expression.SelectFields.Add(cityGroupField)
- e.Expression.GroupByFields.Clear
- e.Expression.GroupByFields.Add(countryGroupField)
- e.Expression.GroupByFields.Add(cityGroupField)
- End If
- End Sub
-
-
-
-
- Gets a reference to the currently used .
-
-
-
- Gets or sets a value indicating whether
- event will be canceled.
-
-
- true, if the event is canceled, otherwise
- false.
-
-
-
-
- Container of misc. grouping settings of RadGrid control
-
-
-
-
- Gets or sets a string that represents the tooltip that will be shown when the
- expand image is hovered.
-
-
-
-
- Gets or sets a string that represents the tooltip that will be shown when the
- collapse image is hovered.
-
-
-
-
- Gets or sets a string that represents the tooltip that will be shown when the
- self-hierarchy expand image is hovered.
-
-
-
-
- Gets or sets a string that represents the tooltip that will be shown when the
- self-hierarchy collapse image is hovered.
-
-
-
-
- This is a collection of item indexes - each item index is unique within the
- collection
-
-
-
-
- Constructs and add item hierarchical index to the collection
- of indexes.
-
-
- The hierarchical-index is based on sequential numbers of
- indxes of items and detail tables. For example
- index Add(1) will construct the hierarchicalindex for Item 1 in MasterTableView.
- Add(1, 0, 2) references to the item with index 2 that belongs to a child table 0 of
- the item 1 in MastertableView.
-
-
-
-
-
- Summary description for GridItemDecorator.
-
-
-
-
- Event info object. Cast to derrived classes to obtain the appropriate instance
-
-
-
-
- Set to true to cancel the default event execution, if available. The ItemCreated and ItemDataBound events cannot be cancelled.
-
-
-
-
- Specifies the position at which the user has dragged and dropped the source item(s) with regards to the
- destination item.
-
-
-
-
- The source item(s) is dropped above (before) the destination item.
-
-
-
-
- The source item(s) is dropped below (after) the destination item.
-
-
-
-
- Contains instance to which belongs the destinationItem
-
-
-
-
- Contains raw RadGrid's HTML which will be transformed to PDF.
-
-
-
-
- Contains export document which will be written to the response
-
-
-
-
- Item that is displayed on top or at the bottom of the each GridTableView base on the settings of
- property. Generally this item displays by default "Add new record" and "Refresh" button,
- but it can be customized using the . The commands bubbled through this item will be fired by
- RadGrid.ItemCommand event.
-
-
-
-
- Class that represents the rows of each GridTableView with RadGrid. All Items in RadGrid inherit from this class.
- RadGrid creates the items runtime, when it binds to data.
-
-
-
-
- Initializes the base properties of an item.
-
-
-
-
-
-
-
-
- Use this method to simulate item command event that bubbles to RadGrid and can be handeled automatically or in a custom manner,
- handling RadGrid.ItemCommand event.
-
- command to bubble, for example 'Page'
- command argument, for example 'Next'
-
-
-
- This method is not intended to be used directly from your code.
-
-
-
-
-
-
- This method is not intended to be used directly from your code
-
-
-
-
-
-
- This method is not intended to be used directly from your code
-
-
-
-
-
- Override this method to change the default logic for rendering the item
-
-
-
-
- Override this method to change the default logic for item visibility
-
-
-
-
-
- Used after postback before ViewState becomes available -
- for example in ItemCreated and ItemDataBound events
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- //get MasterTableView's second (index 1) nested view item
- GridNestedViewItem firstLevelNestedViewItem = (GridNestedViewItem)RadGrid1.MasterTableView.GetItems(GridItemType.NestedView)[1];
- //get second nested view item at level 2 of the hierarchy
- GridNestedViewItem secondLevelNestedViewItem = (GridNestedViewItem)firstLevelNestedViewItem.NestedTableViews[0].GetItems(GridItemType.NestedView)[1];
- //get the first item to be expanded
- GridItem itemToExpand = secondLevelNestedViewItem.NestedTableViews[0].GetItems(GridItemType.Item)[0];
- itemToExpand.ExpandHierarchyToTop();
-
-
- 'get MasterTableView's second (index 1) nested view item
- Dim firstLevelNestedViewItem As GridNestedViewItem = CType(RadGrid1.MasterTableView.GetItems(GridItemType.NestedView)(1), GridNestedViewItem)
- 'get second nested view item at level 2 of the hierarchy
- Dim secondLevelNestedViewItem As GridNestedViewItem = CType(firstLevelNestedViewItem.NestedTableViews(0).GetItems(GridItemType.NestedView)(1), GridNestedViewItem)
- 'get the first item to be expanded
- Dim itemToExpand As GridItem = secondLevelNestedViewItem.NestedTableViews(0).GetItems(GridItemType.Item)(0)
- itemToExpand.ExpandHierarchyToTop()
-
-
- Expands the hierarchy starting from the last level to the top
-
-
-
- Calculate column-span value for a cell using column list, when the cell indicated
- with FromCellIndex should be spanned to ToCellIndex
-
- columns - visible property is taken in count
- cell inbdex of spanned cell
- cell index of next not-spanned cell or -1 for the last cell index
- ColSpan number
-
-
-
- Gets a reference to the GridTableView that owns this
- GridItem.
-
-
- You can use the OwnerTableView property to get an instance of the GridTableView
- that holds the item modified. For example in the
- SelectedIndexChanged event handler you can get the
- GridTableView object like this:
-
- protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e)
- {
- GridTableView tableview = RadGrid1.SelectedItems[0].OwnerTableView;
- }
-
-
- Protected Sub RadGrid1_SelectedIndexChanged(sender As Object, e As EventArgs)
- Dim tableview As GridTableView = RadGrid1.SelectedItems(0).OwnerTableView
- End Sub
-
-
-
-
-
- Gets the ClientID of the GridTableView that
- owns this instance.
-
-
- The OwnerID property will get the ClientID of the
- GridTableView that owns the referenced instance. For example the
- code below will return RadGrid1_ctl01 which is the ClientID of the MasterTableView
- for basic RadGrid:
-
- protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e)
- {
- Label1.Text = RadGrid1.SelectedItems[0].OwnerID;
- }
-
-
- Protected Sub RadGrid1_SelectedIndexChanged(sender As Object, e As EventArgs)
- Label1.Text = RadGrid1.SelectedItems(0).OwnerID
- End Sub
-
-
-
-
-
- Gets the ClientID of the RadGrid instance that
- owns the item.
-
-
- The OwnerGridID property will get the ClientID of the
- Grid instance that owns the referenced item. For example the code
- below will return RadGrid1 which is the ClientID of the owner Grid instance.
-
- protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
- {
- if (e.Item is GridEditableItem && e.Item.IsInEditMode)
- {
- Response.Write(e.Item.OwnerGridID);
-
- }
- }
-
-
- Protected Sub RadGrid1_ItemCreated(sender As Object, e As GridItemEventArgs)
- If Typeof e.Item Is GridEditableItem And e.Item.IsInEditMode Then
- Response.Write(e.Item.OwnerGridID)
- End If
- End Sub
-
-
-
- This would be useful if several controls use the same eventhandler and you need
- to diferentiate the Grid instances in the handler.
-
-
-
-
-
-
-
-
- Gets a value indicating whether this item has child items - or items somehow
- related to this.
-
-
- For example the GridDataItem has child
- NestedViewItem that holds the hierarchy tables when grid is
- rendering hierarchy.
- GroupHeaderItems has the items with a group for children, and so
- on.
-
- protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
- {
- if (e.Item is GridItem && (e.Item as GridItem).HasChildItems == true)
- {
- Label1.Text = "has items";
- }
- }
-
-
- Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As GridItemEventArgs)
- If (Typeof e.Item Is GridItem AndAlso CType(e.Item, GridItem).HasChildItems = True) Then
- Label1.Text = "has items"
- End If
- End Sub
-
-
-
-
-
- Gets a value indicating whether the item can be "expanded" to show its child items
-
-
- Shows whether an item can be "expanded" to show its child items
-
- protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
- {
- if (e.Item is GridItem && (e.Item as GridItem).CanExpand == true)
- {
- Label1.Text = "Item was expanded";
- }
- }
-
-
- Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As GridItemEventArgs)
- If (Typeof e.Item Is GridItem AndAlso CType(e.Item, GridItem).CanExpand = True)
- Label1.Text = "Item was expanded"
- End If
- End Sub
-
-
-
-
-
- The original DataItem from the DataSource. See
- examples section below.
-
-
- For example if you bind the grid to a DataView object the
- DataItem will represent the DataRowView object
- extracted from the DataView for this GridItem. Note
- that the DataItem object is available only when grid binds to data
- (inside the ItemDataBound server event handler).
-
-
-
-
- Gets the index of the GridDataItem in the underlying
- DataTable/specified table from a DataSet.
-
- Integer
-
- This property has a meaning only when the Telerik RadGrid source is
- DataTable.
-
-
-
-
- Gets the index of the grid item among the
- collection. This index also can be used to get the DataKeyValues
- corresponding to this item from a GridTableView.
-
-
- Gets a value representing the index of this item among the
- collection. This index also can be used to
- get the DataKeyValues corresponding to this item from a
- GridTableView.
-
-
-
-
- Gets the index of the row as in the html table object rendered on the client
-
-
-
-
-
-
- Gets the index of the item in the rows collection of the underlying Table server control
-
-
-
-
-
-
- Get the unique item index among all the item in the hierarchy. This index is used when setting item to selected, edited, etc
-
-
- If we have three level hierarchy with two items each and select the first item in
- the third level then the ItemIndexHierarchical will be 1:0_1:0_0
-
- protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e)
- {
- Response.Write(RadGrid1.SelectedItems[0].ItemIndexHierarchical);
- }
-
-
- Protected Sub RadGrid1_SelectedIndexChanged(sender As Object, e As EventArgs)
- Response.Write(RadGrid1.SelectedItems(0).ItemIndexHierarchical)
- End Sub 'RadGrid1_SelectedIndexChanged
-
-
-
-
-
- Gets the respective GridItemType of the grid item.
-
-
- Gets the respective GridItemType of the grid item.
-
- foreach (GridDataItem dataItem in rgdStateRules.MasterTableView.Items)
- {
- if (dataItem.ItemType == GridItemType.Item ||
- dataItem.ItemType == GridItemType.AlternatingItem)
- {
- string reqName = dataItem["SomeColumnUniqueName"]. Text;
- ....
- }
- }
-
-
- Dim dataItem As GridDataItem
- For Each dataItem In rgdStateRules.MasterTableView.Items
- If dataItem.ItemType = GridItemType.Item Or dataItem.ItemType = GridItemType.AlternatingItem Then
- Dim reqName As String = dataItem("SomeColumnUniqueName").Text
- End If
- Next dataItem
-
-
-
-
-
- Gets or sets a value indicating whether the grid item is expanded or
- collapsed.
-
-
- The example below sets all expanded items to collapsed
-
- for(int i = 0; i < RadGrid.Items.Count - 1;i++)
- if(RadGrid.Items[i].Expanded)
- {
- RadGrid.Items[i].Expanded = false;
- }
-
-
- Dim i As Integer
- For i = 0 To (RadGrid.Items.Count - 1) Step -1
- If RadGrid.Items(i).Expanded Then
- RadGrid.Items(i).Expanded = False
- End If
- Next i
-
-
-
-
-
- The example below will hide the GridCommandItem.
-
- if (e.Item is GridCommandItem)
- {
- e.Item.Display = false;
- }
-
-
- If Typeof e.Item Is GridCommandItem Then
- e.Item.Display = False
- End If
-
-
- Sets whether the GridItem will be visible or with style="display:none;"
-
-
- Gets or set a value indicating whether the grid item is selected
-
- You can check whether a certain item is selected using the Selected
- property:
-
- protected void RadGrid1_PreRender(object sender, EventArgs e)
- {
- foreach (GridDataItem dataitem in RadGrid1.MasterTableView.Items)
- {
- if (dataitem.Selected == true)
- {
- //do your thing
- }
- }
- }
-
-
- Protected Sub RadGrid1_PreRender(sender As Object, e As EventArgs)
- Dim dataitem As GridDataItem
- For Each dataitem In RadGrid1.MasterTableView.Items
- If dataitem.Selected = True Then
- 'do your thing
- End If
- Next dataitem
- End Sub 'RadGrid1_PreRender
-
-
-
-
- Sets the Item in edit mode. Requires Telerik RadGrid to rebind.
-
-
- If is set to InPlace, the grid column
- editors will be displayed inline of this item.
-
-
- If is set to EditForms, a new
- GridItem will be created, which will be child of this item
- (GridEditFormItem). The new item will hold the edit form.
-
-
-
- We suggest using IsInEditMode instead of Edit to check whether an Item is in
- edit more or not.
-
-
-
- Gets the index of the Item in the group. This works only when grouping.
-
- This example expands all items that meet the condition:
-
- if (e.Item.GroupIndex == EditItemGroupIndex | EditItemGroupIndex.StartsWith(e.Item.GroupIndex + "_"))
- {
- e.Item.Expanded = true;
- }
-
-
- If e.Item.GroupIndex = EditItemGroupIndex Or EditItemGroupIndex.StartsWith(e.Item.GroupIndex & "_") Then
- e.Item.Expanded = True
- End If
-
-
-
- Returns a string formed: X_Y_Z, where:
- - X is a zero-based value representing the group index (the first group of results
- will have index = 0)
- - Y is a zero-based value representing the group level. If you group the grid
- using 2 criteria, the inner groups will have index = 1.
- - Z is a zero-based value representing the GridItem index in the group (the
- first item will have index = 0)
- Note that if you use more criteria, you will have more
- indexes returned: X_Y_Z_W, where the last one is always the item index in the
- group.
-
-
-
-
- Gets a value indicating whether the grid item is bound to a data source.
-
-
- Default value is true when the grid is databound.
-
-
-
-
- Gets a value indicating whether the grid item is in edit mode at the
- moment.
-
-
- Will locate the TextBox for Item in Edit mode:
-
- if (e.Item is GridEditableItem && e.Item.IsInEditMode)
- {
- TextBox txt = (e.Item as GridEditableItem)["SomeColumnName"].Controls[0] as TextBox;
- }
-
-
- If Typeof e.Item Is GridEditableItem And e.Item.IsInEditMode Then
- ...
- End If
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents the base class for any items that display and edit data in a
- GridTableView of RadGrid. Inheritors has the
- capabilities to:
-
- Locate a table cell based on the column unique names
- Extract values from the cells of column editors
- Has a dictionary of saved-old-values that are necessary for optimistic concurency
- editing oprations
- Edit/browse mode
- EditManager instance, which is capable of locating the column
- editors
-
-
-
-
-
-
-
-
- Extracts values for each column, using
-
- This dictionary to fill, this parameter should not be null
-
-
-
- Extracts values for each column, using and updates values in provided object;
-
- This dictionary to fill, this parameter should not be null
-
-
-
- Get the DataKeyValues from the owner GridTableView with the corresponding item ItemIndex and keyName.
- The keyName should be one of the specified in the array
-
- data key name
- data key value
-
-
- Allows you to access the column editors
-
-
- GridEditManager editMan = editedItem.EditManager;
- IGridEditableColumn editableCol = (column as IGridEditableColumn);
- IGridColumnEditor editor = editMan.GetColumnEditor( editableCol );
-
-
- Dim editMan As GridEditManager = editedItem.EditManager
- Dim editableCol As IGridEditableColumn = CType(column, IGridEditableColumn)
- Dim editor As IGridColumnEditor = editMan.GetColumnEditor(editableCol)
-
-
-
-
-
-
-
-
-
-
-
-
- Gets the old value of the edited item
-
-
- foreach (DictionaryEntry entry in newValues)
- {
- Label1.Text += "\n<br />Key: " + entry.Key + "<br />New value: " + entry.Value + "<br /> Old value: " + editedItem.SavedOldValues[entry.Key] + "<br />";
- }
-
-
-
-
- For Each entry As DictionaryEntry In newValues
- Label1.Text += "" & Microsoft.VisualBasic.Chr(10) & "<br />Key: " + entry.Key + "<br />New value: " + entry.Value + "<br /> Old value: " + editedItem.SavedOldValues(entry.Key) + "<br />"
- Next
-
-
-
-
-
-
-
-
-
-
- string keyValues = ((GridEditableItem)e.Item).KeyValues;
- if (keyValues.Contains("CustomerID"))
- Session["CustomerID"] = keyValues.Substring(13, keyValues.Length - 1);
- else
- Session["OrderID"] = keyValues.Substring(10, keyValues.Length - 1);
-
-
- Dim keyValues As String = CType(e.Item, GridEditableItem).KeyValues
- If keyValues.Contains("CustomerID") Then
- Session("CustomerID") = keyValues.Substring(13, keyValues.Length - 1)
- Else
- Session("OrderID") = keyValues.Substring(10, keyValues.Length - 1)
- End If
-
-
-
-
-
- Summary description for GridDataItem.
-
-
-
-
- Generates a client-side function which fires a command with a given name and arguments
-
-
- GridTableView fireCommand
-
-
- protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e)
- {
- if (e.Item is GridDataItem)
- {
- GridDataItem dataItem = (GridDataItem) e.Item;
- ((Button) dataItem["MyTemplateColumn"].Controls[0]).OnClientClick =
- dataItem.ClientFireCommandFunction("MyCommandName", "");
- }
- }
-
-
- Command's name
- Command's argument
-
-
- Sets the visibility of the children items.
- This method is for Telerik RadGrid internal usage.
-
-
- This method is for Telerik RadGrid internal usage.
-
-
-
- Item that loads an EditForm during binding if is . When in this mode
- RadGrid loads an EditFormItem for each normal data-bound item. EditForm is generated only for the items that are in = true mode.
-
-
-
-
- The table cell where the edit form will be instantiated, during data-binding.
-
-
-
-
- FormColumns are only available when EditFormType is GridEditFormType.AutoGenerated.
- These are the container controls for each edit-form-column. You cna find the edit controls
- in these containers. You should not remove any controls from this containers.
-
-
-
-
- The corresponding DataItem that the edit form is generated for.
-
-
-
-
- It's an item, displaying input controls, which allows user to enter a filter values
- for each visible column in a GridTableView. By default the columns render a textbox
- and a button, displaying the filtering menu on click. This item is visible based on
- the settings of property.
- The items is displayed right under the header row of a GridTabelView.
-
- Setting filter textbox dimensions/changing default filter image
-
-
- Protected Sub RadGrid1_ItemCreated(sender As Object, e As GridItemEventArgs) Handles RadGrid1.ItemCreated
- If Typeof e.Item Is GridFilteringItem Then
- Dim filteringItem As GridFilteringItem = CType(e.Item, GridFilteringItem)
-
- 'set dimensions for the filter textbox
- Dim box As TextBox = CType(filteringItem("ContactName").Controls(0), TextBox)
- box.Width = Unit.Pixel(30)
-
- 'set ImageUrl which points to your custom image
- Dim image As Image = CType(filteringItem("ContactName").Controls(1), Image)
- image.ImageUrl = "<my_image_url>"
- End If
- End Sub 'RadGrid1_ItemCreated
-
-
- Protected void RadGrid1_ItemCreated(Object sender, GridItemEventArgs e)
- {
- If (e.Item Is GridFilteringItem)
- {
- GridFilteringItem filteringItem = e.Item As GridFilteringItem;
-
- //Set dimensions For the filter textbox
- TextBox box = filteringItem["ContactName"].Controls[0] As TextBox;
- box.Width = Unit.Pixel(30);
-
- //Set ImageUrl which points To your custom image
- Image image = filteringItem["ContactName"].Controls[1] As Image;
- image.ImageUrl = "<my_image_url>";
- }
- }
-
-
-
-
-
-
-
-
-
-
-
-
-
- Displays the footer row of a GridTableView with cells for each column in the grid similar to GridHeaderItem.
-
-
-
-
-
-
-
-
-
-
-
-
- The item which splits the groups (when utilizing the grouping feature of RadGrid)
- and provides expand/collapse functionality for them.
-
-
- Here is how you can get reference to the GridGroupHeaderItem on
- ItemDataBound:
-
- Private Sub RadGrid1_ItemDataBound(sender As Object, e As Telerik.Web.UI.GridItemEventArgs)
- If Typeof e.Item Is GridGroupHeaderItem Then
- Dim item As GridGroupHeaderItem = CType(e.Item, GridGroupHeaderItem)
- 'do something here
- End If
- End Sub 'RadGrid1_ItemDataBound
-
-
- private void RadGrid1_ItemDataBound(object sender, Telerik.Web.UI.GridItemEventArgs e)
- {
- if ( e.Item is GridGroupHeaderItem )
- {
- GridGroupHeaderItem item = (GridGroupHeaderItem)e.Item;
- //do something here
- }
- }
- }
-
-
- Created and meaningful only with grouping enabled.
-
- should be applied to have such type of
- item(s).
-
- Customize GridGroupHeaderItem
- Performing calculations in group header
-
-
- Marked for internal usage only
-
-
- Inherited from Control, for internal usage only
-
-
- Inherited from Control, for internal usage only
-
-
- Inherited from Control, for internal usage only
-
-
-
- Method which returns the data items under the
- group.
-
- An array of GridItem instances
-
- The code below can be used to loop through the data items in a group on button
- click handler (for example):
-
- Dim groupHeader As GridGroupHeaderItem = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)(0)
- Dim groupItems As GridItem() = groupHeader.GetChildItems()
- 'traverse the items and operate with them further
-
-
- GridGroupHeaderItem groupHeader= RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)[0] as GridGroupHeaderItem;
- GridItem [] groupItems = groupHeader.GetChildItems();
- //traverse the items and operate with them further
-
-
- Meaningful only with grouping enabled.
-
- should be applied to have
- available.
-
-
-
-
- Method which shows/hides the items in the group designated by the
-
-
- N/A
-
- The code below will hide the items under the first group in the grid:
-
- Dim groupHeader As GridGroupHeaderItem = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)(0)
- groupHeader.SetVisibleChildren(False)
-
-
- GridGroupHeaderItem groupHeader = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)[0] as GridGroupHeaderItem;
- groupHeader.SetVisibleChildren(false);
-
-
- Meaningful only with grouping enabled.
-
- should be applied to have
- available.
-
-
- boolean, determines whether the items in the group will be displayed or
- hidden
-
-
-
- The cell holding the content of the
- N/A
-
- Below is a sample code presenting how to customize the DataCell
- content dynamically on ItemDataBound:
-
- Private Sub RadGrid1_ItemDataBound(sender As Object, e As Telerik.Web.UI.GridItemEventArgs)
- If Typeof e.Item Is GridGroupHeaderItem Then
- Dim item As GridGroupHeaderItem = CType(e.Item, GridGroupHeaderItem)
- Dim groupDataRow As DataRowView = CType(e.Item.DataItem, DataRowView)
-
- 'Clear the present text of the cell
- item.DataCell.Text = ""
- Dim column As DataColumn
- For Each column In groupDataRow.DataView.Table.Columns
-
- 'Check the condition and add only the field you need
- If column.ColumnName = "Country" Then
- item.DataCell.Text += "Customized display - Country is " + groupDataRow("Country").ToString()
- End If
- Next column
- End If
- End Sub 'RadGrid1_ItemDataBound
-
-
- Private void RadGrid1_ItemDataBound(Object sender, Telerik.Web.UI.GridItemEventArgs e)
- {
- If ( e.Item Is GridGroupHeaderItem )
- {
- GridGroupHeaderItem item = (GridGroupHeaderItem)e.Item;
- DataRowView groupDataRow = (DataRowView)e.Item.DataItem;
-
- //Clear the present text of the cell
- item.DataCell.Text = "";
- foreach( DataColumn column In groupDataRow.DataView.Table.Columns)
-
- //Check the condition And add only the field you need
- If ( column.ColumnName == "Country" )
- {
- item.DataCell.Text += "Customized display - Country is " + groupDataRow
- ["Country"].ToString();
- }
- }
- }
-
-
- Created and meaningful only with grouping enabled.
-
- should be applied to have
- with DataCell.
-
- Customize GridGroupHeaderItem
- Performing calculations in group header
-
-
-
- Boolean property indicating whether the relevant
- has child items inside the group it forms.
-
- boolean
-
-
- Dim groupHeader As GridGroupHeaderItem = grid.MasterTableView.GetItems(GridItemType.GroupHeader)(0)
- If (groupHeader.HasChildItems) Then
- 'operate with the items
- Else
- 'do something else
- End If
-
-
- GridGroupHeaderItem groupHeader = grid.MasterTableView.GetItems(GridItemType.GroupHeader)[0] as GridGroupHeaderItem;
- if (groupHeader.HasChildItems)
- {
- //operate with the items
- }
- else
- {
- //do something else
- }
-
-
- Meaningful only with grouping enabled.
-
- should be applied to have
- with this boolean property.
-
-
-
- Marked for internal usage
-
-
-
- Summary description for GridHeaderItem.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Summary description for GridMultiRowItem.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Item that contains the nested instances of GridTableView class, that appear as a child item of the corresponding GridDataItem
-
-
- The child tables will be created when grid is databinding and will be added as controls of the
- Then these tables can also be accessed using the array.
-
-
-
-
- Creates an instance of GridNestedViewItem For
- internal usage only.
-
-
-
-
- An instance of GridTableView Class, which will
- contain the created item
-
-
- The value for ItemIndex Property
- (Telerik.Web.UI.GridItem) property
-
-
- The value for DataSetIndex Property
- (Telerik.Web.UI.GridItem) property
-
-
-
- Defines the default logic for rendering the item. For internal usage only.
-
-
-
-
- This method is not intended to be used directly from your code
-
-
-
-
- This method is not intended to be used directly from your code
-
-
-
-
- Gets the cell that contains the .
- System.Web.UI.WebControls.TableCell
-
-
- foreach (GridNestedViewItem nestedViewItem in radgrid1.MasterTableView.GetItems(GridItemType.NestedView))
- {
- TableCell cell = nestedViewItem.NestedViewCell;
- cell.BorderColor = System.Drawing.Color.Red;
- }
-
-
- Dim nestedViewItem As GridNestedViewItem
- For Each nestedViewItem In RadGrid1.MasterTableView.GetItems(GridItemType.NestedView)
- Dim cell As TableCell = nestedViewItem.NestedViewCell
- cell.BorderColor = System.Drawing.Color.Red
- Next nestedViewItem
-
-
-
-
-
- Gets an array of GridTableView objects residing in the .
-
-
-
- GridTableView nestedTable = RadGrid1.MasterTableView.Items[0].ChildItem.NestedTableViews[0];
-
-
- Dim nestedTable As GridTableView = RadGrid1.MasterTableView.Items(0).ChildItem.NestedTableViews(0)
-
-
-
-
-
- Gets a reference to a that is parent of this
-
-
-
-
-
- GridNoRecordsItem is used to display no records template, in the corresponding table view has is set to true (the default)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Summary description for GridPagerItem.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns instance of control which contains grid numeric pager
-
- If you have already defined an GridPagerTemplate, but still standard numeric
- pager is required you can attain this using the following code
-
- protected void RadGrid1_ItemCreated(object sender, Telerik.Web.UI.GridItemEventArgs e)
- {
- if (e.Item is GridPagerItem)
- {
- GridPagerItem gridPager = e.Item as GridPagerItem;
- Control numericPagerControl = gridPager.GetNumericPager();
- gridPager.Controls[0].Controls.Add(numericPagerControl);
- }
- }
-
-
- Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.Web.UI.GridItemEventArgs)
- If Typeof e.Item Is GridPagerItem Then
- Dim gridPager As GridPagerItem = TryCast(e.Item, GridPagerItem)
- Dim numericPagerControl As Control = gridPager.GetNumericPager()
- gridPager.Controls(0).Controls.Add(numericPagerControl)
- End If
- End Sub
-
-
-
-
- Gets the position of the pager in the RadGrid. Default value is false.
-
-
- if (((GridPagerItem)this.Item).IsTopPager)
- {
- Item.Visible = false;
- return;
- }
-
-
- If CType(Me.Item, GridPagerItem).IsTopPager Then
- Item.Visible = False
- Return
- End If
-
-
-
-
- The Cell where the PagerItems are located
-
-
- if (e.Item is GridPagerItem)
- {
- GridPagerItem pagerItem = (e.Item as GridPagerItem);
- pagerItem.PagerContentCell.Controls.Clear();
- //custom paging
- }
-
-
- If Typeof e.Item Is GridPagerItem Then
- Dim pagerItem As GridPagerItem = CType(e.Item, GridPagerItem)
- pagerItem.PagerContentCell.Controls.Clear
- 'custom paging
- End If
-
-
-
-
-
- GridStatusBarItem is used to display information messages for
- Telerik RadGrid status. Meaningful only when Telerik RadGrid is in AJAX
- mode.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The mode of the pager defines what buttons will be displayed and how the pager
- will navigate through the pages.
-
-
-
- The grid Pager will display only the Previous and Next link buttons.
-
-
- The grid Pager will display only the page numbers as link buttons.
-
-
-
- The grid Pager will display the Previous button, then the page numbers and then
- the Next button.
-
-
-
-
- The grid Pager will display the Previous button, then the page numbers and then
- the Next button. On the next Pager row, the Pager will display text boxes for
- navigating to a specific page and setting the Page size (number of items per
- page).
-
-
-
-
- The grid Pager will display text boxes for navigating to a specific page and
- setting the Page size (number of items per page).
-
-
-
-
- The grid Pager will display a slider for very fast and AJAX-based navigation
- through grid pages.
-
-
-
- This enumeration defines the possible positions of the pager item
-
-
-
- The Pager item will be displayed on the bottom of the grid. (Default
- value)
-
-
-
- The Pager item will be displayed on the top of the grid.
-
-
-
- The Pager item will be displayed both on the bottom and on the top of the
- grid.
-
-
-
-
- RadGrid and GridTableView use instance of this class to set style of thir PagerItem-s when rendering
-
-
-
-
- Summary description for GridTableItemStyle.
-
-
-
-
- Returns 'True' if none of the properties have been set
-
-
-
- Returns true if none of the properties have been set.
-
- Gets a value indicating whether the default pager will be used, i.e. no
- customizations have been made.
-
-
-
-
- Gets a value indicating whether the pager is displayed on the bottom of the
- grid.
-
-
- Returns true if the pager will be displayed on the bottom of the
- grid. Otherwise false.
-
-
-
-
- Gets a value indicating whether the pager is displayed on the top of the
- grid.
-
-
- Returns true if the pager will be displayed on the top of the
- grid. Otherwise false.
-
-
-
-
- Gets or sets the mode of Telerik RadGrid Pager. The mode defines what the pager
- will contain. This property accepts as values only members of the GridPagerMode Enumeration.
-
-
- Returns the pager mode as one of the values of the
- GridPagerMode
- Enumeration.
-
-
- You should have Paging enabled by setting the
- property.
-
-
-
-
- Text that would appear if Mode is PrevNext for 'next' page button
-
-
-
-
- Text that would appear if Mode is PrevNext for 'last' page button
-
-
-
-
- Gets or sets url for Previous Page image
-
-
-
-
- Gets or sets url for Next Page image
-
-
-
-
- Gets or sets url for first page image
-
-
-
-
- Gets or sets url for first page image
-
-
-
-
- ToolTip that would appear if Mode is PrevNext for 'next' page button
-
-
-
-
- ToolTip that would appear if Mode is PrevNext for 'next' page button
-
-
-
-
- ToolTip that would appear if Mode is PrevNext for 'last' page button
-
-
-
-
- ToolTip that would appear if Mode is PrevNext for 'prev' page button
-
-
-
-
- ToolTip that would appear if Mode is PrevNext for 'next' page button
-
-
-
-
- ToolTip that would appear if Mode is PrevNext for 'prev' page button
-
-
-
-
- The text of the page size label situated before the page size combo.
-
-
-
-
- Gets or sets the number of buttons that would be rendered if pager Mode is
-
-
-
- returns the number of button that will be displayed. The default value is 10
- buttons.
-
-
- By default 10 buttons will be displayed. If the number of grid pages is greater
- than 10, ellipsis will be displayed.
-
-
-
-
- Gets or sets the Position of pager item(s).Accepts only values, members of the
- GridPagerPosition Enumeration.
-
-
- Returns the Pager position as a value, member of the
- GridPagerPosition
- Enumeration.
-
-
-
-
- Text that would appear if Mode is PrevNext for 'previous' page button
-
-
-
-
- Text that would appear if Mode is PrevNext for 'first' page button
-
-
-
- Gets or sets the visibility of the pager item
-
-
-
- In order to display the grid pager regardless of the number of records returned
- and the page size, you should set this property of the corresponding GridTableView to
- true. Its default value is false.
-
-
- Gets or set a value indicating whether the Pager will be visible regardless of
- the number of items. (See the remarks)
-
-
- true, if pager will be displayed, regardless of the number of
- grid items, othewise false. By fefault it is
- false.
-
-
-
-
- Get or set a value indicating whether the SEO (Search Engine Optimized) paging
- enabled
-
- December 15, 2006
-
-
-
- Gets or sets the horizontal align of the pager. Accepts as values members of the
- enumeration.
-
-
- the horizontal align of the pager as a value from the
- enumeration.
-
-
-
-
- Gets or sets a value indicating whether the pager text or only the pager buttons
- will be displayed.
-
-
- true if both pager text and buttons will be displayed, otherwise
- false. By default it is true.
-
-
-
-
- The string used to format the description text that appears in a pager item. See
- the remarks.
-
-
- The parameters {0) - {4} are mandatory.
-
- Parameter {0} is used to display current page number.
- Parameter {1} is total number of pages.
- Parameter {2} will be replaced with the number of the first item in the current
- page.
- Parameter {3} will be set to the number of the last item in the current page.
- Parameter {4} indicates where pager buttons would appear.
- Parameter {5} corresponds to number of all items in the datasource.
-
-
- The default value is:
- Change page: {4} Displaying page {0} of {1}, items {2}
- to {3} of {5}
-
-
-
-
- Summary description for GridPagingManager.
-
-
-
-
- Number of items in the data-source
-
-
-
-
- Number of items in the current page
-
-
-
-
- Represents the paper size used when exporting to PDF.
-
-
-
-
- Container of misc. grouping settings of RadGrid control
-
-
-
-
- Gets or sets the physical paper size that RadGrid will use when exporting to PDF.
-
-
- It will be overriden by setting PageWidth and PageHeight explicitly.
-
-
-
-
- Gets or sets the page width that RadGrid will use when exporting to PDF.
-
-
- This setting will override any predefined value that comes from the PaperSize property.
-
-
-
-
- Gets or sets the page height that RadGrid will use when exporting to PDF.
-
-
- This setting will override any predefined value that comes from the PaperSize property.
-
-
-
-
- This property describes the different types of font embedding: Link,
- Embed and Subset.
-
-
- Possible values:
-
-
-
- Link
- The font program is referenced by name in the rendered PDF. Anyone who
- views a rendered PDF with a linked font program must have that font
- installed on their computer otherwise it will not display correctly.
-
-
-
-
- Embed
- The entire font program is embedded in the rendered PDF. Embedding the
- entire font program guarantees the PDF will display as intended by the
- author on all computers, however this method does possess several
- disadvantages:
-
-
-
-
- Font programs can be extremely large and will significantly
- increase the size of the rendered PDF. For example, the MS
- Gothic TrueType collection is 8MB!
-
-
-
-
- Certain font programs cannot be embedded due to license
- restrictions. If you attempt to embed a font program that
- disallows embedding, RadGrid will substitute the font with a
- base 14 font and generate a warning message.
-
-
-
-
-
-
- Subset (default value) Subsetting a font will
- generate a new font that is embedded in the rendered PDF that contains
- only the chars referenced by RadGrid. For example, if a particular
- RadGrid utilised the Verdana font referencing only the character 'A', a
- subsetted font would be generated at run-time containing only the
- information necessary to render the character 'A'.
-
- Subsetting provides the benefits of embedding and significantly reduces
- the size of the font program. However, small processing overhead is
- incurred to generated the subsetted font.
-
-
-
-
-
-
-
- GridPropertyEvaluator
- A DataBinder.Eval() workalike that is a bit more forgiving and does not throw exceptions when it can't find a property.
-
-
-
-
- Summary description for GridResizing.
-
-
-
-
- Contains properties related to customizing the settings for scrolling operation
- in Telerik RadGrid.
-
-
-
-
- Gets or sets a value indicating whether scrolling will be enabled in
- Telerik RadGrid.
-
- true, if scrolling is enabled, otherwise false (the default value).
-
-
-
- Gets or sets a value specifying the grid height in pixels (px) beyond which the
- scrolling will be enabled.
-
- the default value is 300px
-
-
-
- Gets or sets a value indicating whether grid column headers will scroll as the
- rest of the grid items or will remain static (MS Excel ® style).
-
-
- true if headers remain static on scroll, otherwise
- false (the default value).
-
-
- This property is meaningful only when used in conjunction with
- set to true.
-
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will keep the
- scroll position during postbacks.
-
-
- This property is meaningful only when used in conjunction with
- set to true.
-
-
- true (the default value), if Telerik RadGrid keeps
- the scroll position on postback, otherwise false .
-
-
-
-
- This property is particularly useful when working with huge datasets. Using
- the grid scrollbar, you can change the grid pages just like in Microsoft
- Word®. When scrolling with the virtual scrollbar,
- Telerik RadGrid uses AJAX requests to change the pages, i.e. no
- Postbacks are performed. The overall behavior is smooth and with no flicker.
- Note that you should have AJAX enabled for Telerik RadGrid by
- setting the EnableAJAX="True".
-
-
- Gets or sets a value indicating whether Telerik RadGrid will change
- the pages when you scroll using the grid scroller. This in terms of
- Telerik RadGrid is called Virtual Scrolling.
-
-
- true, if virtual scrolling is enabled, otherwise
- false (the default value).
-
-
-
-
- Provides properties related to setting the client-side selection in
- Telerik RadGrid.
-
-
- You can get a reference to this class using
- property.
-
-
-
- not currently available
-
-
-
-
- not currently available
-
-
-
-
-
- Gets or sets a value indicating whether you will be able to select a grid row on
- the client by clicking on it with the mouse.
-
-
- true, if you will be able to select a row on the client, otherwise false (the
- default value).
-
-
-
- not currently available
-
-
-
-
- not currently available
-
-
-
-
-
- Gets or sets a value indicating whether you will be able to select multiple rows
- by dragging a rectangle around them with the mouse.
-
-
- true, if you can select rows by dragging a rectangle with the mouse, otherwise
- false (the default value)
-
-
-
-
- Holds the column names presenting the self-referencing relations in the source
- table.
-
-
- <MasterTableView HierarchyDefaultExpanded="true" HierarchyLoadMode="Client"
- EnableNoRecordsTemplate="false"
- DataKeyNames= "ID,ParentID" Width="100%">
- <SelfHierarchySettings ParentKeyName="ParentID" KeyName="ID"
- />
- </MasterTableView>
-
- Meaningful in cases of self-referenced grid.
-
-
- This method is for Telerik RadGrid internal usage.
-
- Checks if a self-hierarchy settings property value was changed and differs from its
- default.
-
-
-
-
- Gets or sets a value representing the parent ID field when building the
- self-referencing hierarchy.
-
-
- The value property must be included in the DataKeyNames array
- for the MasterTableView.
-
-
- string, representing the parent ID of the current table
- level.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets a value, representing the ID of the current table level in
- self-referencing hierarchy structure.
-
- string, representing the current table level.
-
- The value property must be included in the DataKeyNames array
- for the MasterTableView.
-
-
-
-
-
-
-
-
-
-
-
-
-
- This property can be set only once when the grid is initialized
- and can not be modified.
-
-
- Gets or sets a value indicating the level-depth limit of the nested
- tables.
-
-
- integer, representing the depth limit in levels of nesting. By
- default the limit is 10 levels.
-
-
-
- Enumeration representing the order of sorting data in RadGrid
-
-
- do not sort the grid data
-
-
- sorts grid data in ascending order
-
-
- sorts grid data in descending order
-
-
-
- Class that is used to define sort field and sort order for RadGrid
-
-
-
-
-
-
-
-
- This method gives the string representation of the sorting order. It can be
- either "ASC" or "DESC"
-
-
-
-
- Returns a GridSortOrder enumeration based on the string input. Takes either "ASC"
- or "DESC"
-
-
-
-
- This method gives the string representation of the sorting order. It can be
- either "ASC" or "DESC"
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the sort order.
- The SortOrder paremeter should be either "Ascending", "Descending" or "None".
-
-
-
-
-
-
-
-
- Parses a string representation of the sort order and returns
- GirdSortExpression.
-
-
-
- Gets or sets the name of the field to which sorting is applied.
-
-
- Sets or gets the current sorting order.
-
-
-
- A collection of objects. Depending on the value of
- it holds single
- or multiple sort expressions.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns an enumerator that iterates through the
- GridSortExpressionCollection.
-
-
-
- Adds a to the collection.
-
-
- Clears the GridSortExpressionCollection of all items.
-
-
-
- Find a SortExpression in the collection if it contains any with sort field = expression
-
- sort field
-
-
-
-
- If is true adds the sortExpression in the collection.
- Else any other expression previously stored in the collection wioll be removed
-
-
-
-
-
- If is true adds the sortExpression in the collection.
- Else any other expression previously stored in the collection wioll be removed
-
- String containing sort field and optionaly sort order (ASC or DESC)
-
-
-
- Adds a to the collection at the specified
- index.
-
-
- As a convenience feature, adding at an index greater than zero will set the
- to true.
-
-
-
- Removes the specified from the collection.
-
-
-
- Returns true or false depending on whether the specified sorting expression exists
- in the collection. Takes a parameter.
-
-
-
-
- Returns true or false depending on whether the specified sorting expression
- exists in the collection. Takes a string parameter.
-
-
-
-
- Adds the sort field (expression parameter) if the collection does not alreqady contain the field. Else the sort order of the field will be inverted. The default change order is
- Asc -> Desc -> No Sort. The No-Sort state can be controlled using property
-
-
-
-
-
- Get a comma separated list of sort fields and sort-order, in the same format used by
- DataView.Sort string expression. Returns null (Nothing) if there are no sort expressions in the collection
-
- Comma separated list of sort fields and optionaly sort-order, null if there are no sort expressions in the collection
-
-
-
- Searches for the specified
- GridSortExpression and
- returns the zero-based index of the first occurrence within the entire
- GridSortExpressionCollection.
-
-
-
-
- If false, the collection can contain only one sort expression at a time.
- Trying to add a new one in this case will delete the existing expression
- or will change the sort order if its FiledName is the same.
-
-
-
- Returns the number of items in the GridSortExpressionCollection.
-
-
-
- Gets a value indicating whether access to the GridSortExpressionCollection is
- synchronized (thread safe).
-
-
-
- This is the default indexer of the collection - takes an integer value.
-
-
-
-
-
-
-
-
Gets an object that can be used to synchronize access to the
- GirdSortExpressionCollection.
-
-
-
-
-
-
- Allow the no-sort state when changing sort order.
-
-
-
-
- Holds miscellaneous properties related to sorting like the localization
- properties.
-
-
-
-
- Gets or sets the tooltip that will be displayed when you hover the sorting button
- and there is no sorting applied.
-
-
-
-
- Gets or sets the tooltip that will be displayed when you hover the sorting button
- and the column is sorted ascending.
-
-
-
-
- Gets or sets the tooltip that will be displayed when you hover the sorting button
- and the column is sorted descending.
-
-
-
-
- Defines whether a predefined CssClass will be applied to the sorted column's cells
- Default value is True
-
-
-
-
- State managemenet helper. This class is intended to be used only internally in RadGrid.
-
-
-
- This class holds settings related to the StatusBar item.
-
- <StatusBarSettingsReadyText="Stand
- by"/>
-
- November 26, 2006
-
-
- Gets the ID of the Label that will display the status message.
-
-
-
- Gets or sets the text that will be displayed in
- GridStatusBarItem when Telerik RadGrid does not perform
- any operations.
-
- the default value is "Ready"
-
-
-
- Gets or sets the text that will be displayed in
- GridStatusBarItem when Telerik RadGrid is performing an
- AJAX request.
-
- the default value is "Loading..."
-
-
-
- A String Tokenizer that accepts Strings as source and delimiter. Only 1 delimiter is supported (either String or char[]).
-
-
-
-
- Constructor for StringTokenizer Class.
-
- The Source String.
- The Delimiter String. If a 0 length delimiter is given, " " (space) is used by default.
-
-
-
- Constructor for StringTokenizer Class.
-
- The Source String.
- The Delimiter String as a char[]. Note that this is converted into a single String and
- expects Unicode encoded chars.
-
-
-
- Constructor for StringTokenizer Class. The default delimiter of " " (space) is used.
-
- The Source String.
-
-
-
- Empty Constructor. Will create an empty StringTokenizer with no source, no delimiter, and no tokens.
- If you want to use this StringTokenizer you will have to call the NewSource(string s) method. You may
- optionally call the NewDelim(string d) or NewDelim(char[] d) methods if you don't with to use the default
- delimiter of " " (space).
-
-
-
-
- Method to add or change this Instance's Source string. The delimiter will
- remain the same (either default of " " (space) or whatever you constructed
- this StringTokenizer with or added with NewDelim(string d) or NewDelim(char[] d) ).
-
- The new Source String.
-
-
-
- Method to add or change this Instance's Delimiter string. The source string
- will remain the same (either empty if you used Empty Constructor, or the
- previous value of source from the call to a parameterized constructor or
- NewSource(string s)).
-
- The new Delimiter String.
-
-
-
- Method to add or change this Instance's Delimiter string. The source string
- will remain the same (either empty if you used Empty Constructor, or the
- previous value of source from the call to a parameterized constructor or
- NewSource(string s)).
-
- The new Delimiter as a char[]. Note that this is converted into a single String and
- expects Unicode encoded chars.
-
-
-
- Method to get the number of tokens in this StringTokenizer.
-
- The number of Tokens in the internal ArrayList.
-
-
-
- Method to probe for more tokens.
-
- true if there are more tokens; false otherwise.
-
-
-
- Method to get the next (string)token of this StringTokenizer.
-
- A string representing the next token; null if no tokens or no more tokens.
-
-
-
- Gets the Source string of this Stringtokenizer.
-
- A string representing the current Source.
-
-
-
- Gets the Delimiter string of this StringTokenizer.
-
- A string representing the current Delimiter.
-
-
-
- The frame attribute for a table specifies which sides of the frame surrounding
- the table will be visible.
-
-
-
- No sides.
-
-
- The top side only.
-
-
- The bottom side only.
-
-
- The top and bottom sides only.
-
-
- The left-hand side only.
-
-
- The right-hand side only.
-
-
- The right and left sides only.
-
-
- All four sides.
-
-
- All four sides
-
-
-
- Specifies the two possible text directions. Related to
- Telerik RadGrid support for right-to-left languages.
-
-
-
- Left-To-Right direction
-
-
- Right-To-Left direction
-
-
-
- Defines the possible modes for loading the child items when
- RadGrid displays hierarchy.
-
-
-
-
- All child GridTableViews will be bound immediately when DataBind occurs for a parent GridTableView or RadGrid.
-
-
-
-
-
-
-
- DataBind of a child GridTableView would only take place when an item is Expanded .
- This is the default value of
-
-
-
-
- This mode is similar to ServerBind, but items are expanded client-side, using
- JavaScript manipulations, instead of postback to the server.
-
- In order to use client-side hierarchy expand, you will need to set also
- to
- true.
-
-
-
-
-
- Specifies where the grouping will be handled. There are two options:
-
- Server-side - GridTableView.GroupLoadMode.Server
- Client-side -
- GridTableView.GroupLoadMode.Client
-
-
-
-
- This is the default behavior. Groups are expanded after postback to the server
- for example:
-
-
-
-
-
-
- <MasterTableView GroupLoadMode="Server">
-
-
-
-
-
- Groups will be expanded client-side and no postback will be performed.
-
-
-
-
-
-
- <MasterTableView GroupLoadMode="Client">
-
- and set the client setting AllowGroupExpandCollapse to
- true:
-
-
-
-
-
- To display the grid column editors inline when switching grid item in edit
- mode (see the screenshot below), you simply need to change the
- EditMode property to InPlace.
-
-
- To display the grid column editors in auto-generated form when switching grid
- item in edit mode (see the screenshot below), you simply need to change the
- MasterTableView EditMode property to
- EditForms.
-
-
-
-
-
- Telerik RadGrid will display the column editors inline when switching
- grid item in edit mode
-
-
-
-
- Telerik RadGrid will display the grid column editors in
- auto-generated form when switching grid item in edit mode
-
-
-
-
- Indicate where RadGrid would store its data
-
-
-
-
- DataSource (or generated html tables) data will not be stored.
- RadGrid will fire NeedDataSource event and will bind after each postback
-
-
-
-
- Default - RadGrid stores data in the view-state bag.
-
-
-
-
- Discribe how RadGrid whould respond if the
- is invalid when data-binding. See
-
-
-
-
-
- CurrentPageIndex would be set to 0
-
-
-
-
- CurrentPageIndex would be set to current page count - 1
-
-
-
-
- RadGrid would repord an InvalidOperationException.
-
-
-
-
- InsertItem will be shown on first page
-
-
-
-
- InsertItem will be shown on the last page
-
-
-
-
- InsertItem will be shown on the current page
-
-
-
-
- Specifies the position of the in
- Telerik RadGrid.
-
-
-
- There will be no command item.
-
-
- The command item will be above the Telerik RadGrid
-
-
- The command item will be on the bottom of Telerik RadGrid
-
-
-
- The command item will be both on the top and bottom of
- Telerik RadGrid.
-
-
-
-
- Specifies the position of the in
- Telerik RadGrid.
-
-
-
- The command item will be above the Telerik RadGrid
-
-
- The command item will be on the bottom of Telerik RadGrid
-
-
- Represents one table of data.
-
- In case of flat grid structure, i.e. no hierarchy levels, this object is the
- MasterTableView itself.
- In case of hierarchical structure, the topmost GridTableView is
- the MasterTableView. All inner (child) tables are refered as
- DetailTables. Each table that has children tables has a collection called
- where you can access these tables.
-
-
-
- Gets the owner RadGrid object.
- The owner RadGrid object.
- OwnerID Property
-
-
- Gets the rendering style of a FilterItem.
-
-
- Gets the rendering style of a CommandItem.
-
-
-
- Constructs a new GridTableView and sets as its owner the RadGrid
- object.
-
- GridTableView Method
- GridTableView Method
-
-
-
- Constructs a new GridTableView and sets as its owner the
- RadGrid object. Sets the IsTrackingViewState property
- to the corresponding value of the boolean parameter.
-
- GridTableView Method
- GridTableView Method
- The owner RadGrid object
-
- Indicates whether RadGrid is saving changes to its view
- state.
-
-
-
-
- Default contructor for GridTableView - generally used by Page
- serializer only.
-
- GridTableView Method
- GridTableView Method
-
-
-
- Swaps columns appearance position using the unique names of the two
- columns.
-
- SwapColumns Method
- first column unique name
- second column unique name
-
-
- Swaps columns appearance position using order indexes of the two columns.
-
- You should have in mind that GridExpandColumn and
- RowIndicatorColumn are always in front of data columns so that's why
- you columns will start from index 2.
-
- SwapColumns Method
- first column order index
- second column order index
-
-
-
- Removes all selected items that belong to this GridTableView
- instance.
-
- GridSelecting Class
- ClearEditItems Method
-
-
-
- Removes all edit items that belong to the GridTableView
- instance.
-
- GridEditFormItem Class
- ClearSelectedItems Method
-
-
-
- Forces the Owner RadGrid to fire
- event then calls
- .
-
- GridNeedDataSourceEventHandler Delegate
- DataBind Method
-
- The Rebind method should be called every time a change to the
- RadGrid columns/items has been made.
-
-
-
- Binds the data source to the RadGrid instance.
-
- Call this member to bind partially RadGrid. Before calling this
- method the property should be assigned or you can use
- method instead. Use
- or member to bind all
- GridTableViews in RadGrid.
-
- DataSource Property
- Rebind Method
-
-
- For internal usage.
-
-
-
-
- For internal usage.
-
-
-
-
-
- Returns a based on its
- .
-
-
- The GridColumn object related to the
- columnUniqueName.
-
- GridColumn Class
- UniqueName Property (Telerik.Web.UI.GridColumn)
-
- The following code snippet demonstrates how you to access a column at
- PreRender RadGrid event and make set it as invisible:
- [ASPX/ASCX]
- <radg:radgrid id="RadGrid1" DataSourceID="AccessDataSource1"
- runat="server" OnPreRender="RadGrid1_PreRender">
- </radg:radgrid>
- <asp:AccessDataSource ID="AccessDataSource1"
- DataFile="~/Grid/Data/Access/Nwind.mdb"
- SelectCommand="SELECT CustomerID, CompanyName, ContactName FROM Customers"
- runat="server">
- </asp:AccessDataSource>
-
- protected void RadGrid1_PreRender(object sender, System.EventArgs e)
- {
- RadGrid1.MasterTableView.GetColumn( "CustomerID" ).Visible = false;
- }
-
-
- GetItems Method
- The for the requested column.
-
-
-
- Returns a based on its
- .
-
- The for the requested column.
-
-
-
- Returns a collection of objects based on their
- .
-
-
- A s collection of objects based on their
- .
-
- GetColumn Method
-
- The , which will be used as a criteria for
- the collection.
-
-
-
-
- Applies all view changes to control hierarchy before rendering
-
-
-
-
- This method is used by RadGrid internally. Please do not use.
-
-
-
-
-
- For internal structure usage.
-
-
-
- Recreates all GridItems and chld controls, using the DataSource or the ViewState
-
- 'True' means that DataBind() is executing. 'False' means that Viewtate
- has been just loaded after postback.
-
-
-
- Exports the grid data in CSV format using the properties set in the
- ExportSettings.
-
- ExportToWord Method
- ExportToExcel Method
- MS Excel and MS Word online example
-
-
-
- Exports the grid data in PDF format using the properties set in the
- ExportSettings.
-
- Exporting online example
-
-
-
- Exports the grid data in Microsoft Excel ® format using the properties set in the
- ExportSettings.
-
- ExportToWord Method
- ExportToExcel Method
- MS Excel and MS Word online example
-
-
-
- Exports the grid data in Microsoft Word ® format based on the selected ExportSettings.
-
- GridExportSettings Class
- ExportToExcel Method
- ExportToExcel2007 Method
- ExportToWord2007 Method
-
-
- For internal usage.
-
-
-
-
-
-
- For internal usage.
-
-
-
- The passed IDictionary object (like Hashtable for example) will be filled with the
- names/values of the corresponding column data-fields and their values. Only
- instances of type support extracting values.
-
- Using grid server-side API for extraction
- the dictionary that will be filled
- the item to extract values from
-
-
-
- Perform asynchronous update operation, using the DataSource control API and the
- Rebind method. Please, make sure you have specified the correct
- DataKeyNames for the . When the
- asynchronous operation calls back, RadGrid will fire
- event.
-
-
- The following online example uses PerformUpdate method:
-
-
- Edit on double-click
-
- DataKeyNames Property
- PerformInsert Method
- PerformDelete Method
-
-
-
- Perform asynchronous update operation, using the DataSource control API. Please
- make sure you have specified the correct DataKeyNames for the
- GridTableView. When the asynchronous operation calls back, RadGrid will fire
- event. The boolean property defines if
- RadGrid will after the update.
-
- PerformInsert Method
- PerformDelete Method
- the item that is in edit mode and should be updated
- set to true to prevent grid from binding after the update operation completes
-
-
-
- Perform asynchronous insert of the new item, diplayed by RadGrid when in edit mode,
- using the DataSourceControl API, then . When the
- asynchronous operation calls back, RadGrid will fire
- event.
-
- PerformUpdate Method
- PerformDelete Method
-
-
-
- Get the item that appears when grid is in Insert Mode.
-
- PerformInsert Method
- A reference to the newly inserted item for the respective GridTableView.
-
- There is scenarios in which you need to make some changes with/depending on
- the inserted item.
- If you want to predifine some controls values on item insertion, you should
- use the ItemCommand server-side event to access it:
-
- Private Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs) Handles RadGrid1.ItemCommand If (e.CommandName = RadGrid.InitInsertCommandName) Then
- e.Canceled = True e.Item.OwnerTableView.InsertItem() Dim insertedItem As GridEditableItem = e.Item.OwnerTableView.GetInsertItem()
- Dim editFormItem As GridEditFormItem = CType(insertedItem, GridEditFormItem)
Dim box As TextBox = CType(MyUserControl.FindControl("insertedItem"), TextBox) box.Text = "11" End If End Sub
-
- If you want to get access to
- the newly added row and its values to update in a custom data source, you can use
- the InsertCommand event:
- [C#]
-
- protected void RadGrid1_InsertCommand(object source, GridCommandEventArgs e) { GridDataInsertItem gridDataInsertItem = (GridDataInsertItem)(RadGrid1.MasterTableView.GetInsertItem());
- Hashtable ht = new Hashtable(); gridDataInsertItem.ExtractValues(ht); //Loop through each "DictionaryEntry" in hash table and insert using key value foreach (DictionaryEntry ent in ht)
- { //get the key values and insert to custom datasource. }
- }
-
- [Visual Basic]
-
- Protected Sub RadGrid1_InsertCommand(ByVal source As Object, ByVal e As GridCommandEventArgs) Dim gridDataInsertItem As GridDataInsertItem = CType(RadGrid1.MasterTableView.GetInsertItem,GridDataInsertItem)
- Dim ht As Hashtable = New Hashtable gridDataInsertItem.ExtractValues(ht) 'Loop through each "DictionaryEntry" in hash table and insert using key value For Each ent As DictionaryEntry In ht
- 'get the key values and insert to custom datasource. Next End Sub
-
-
-
-
-
- Performs asynchronous insert operation, using the DataSourceControl API, then
- Rebinds. When the asynchronous operation calls back, RadGrid will fire
- event.
-
- PerformUpdate Method
- PerformDelete Method
- item to be inserted
-
-
-
- Perform asynchronous insert operation, using the DataSource control API.
- When the asynchronous operation calls back, RadGrid will fire event.
-
- PerformUpdate Method
- PerformDelete Method
- the item to be inserted
- True to prevent from binding after the insert operartion completes.
-
-
-
- Perform asynchronous delete operation, using the DataSourceControl API the Rebinds the grid. Please make sure you have specified the correct DataKeyNames for the GridTableView.
- When the asynchronous operation calls back, RadGrid will fire event.
-
- DataKeyNames Property
- PerformUpdate Method
- PerformInsert Method
- The item that should be deleted
-
-
-
- Perform delete operation, using the DataSourceControl API. Please make sure you have specified the correct DataKeyNames for the GridTableView.
-
- DataKeyNames Property
- PerformUpdate Method
- PerformInsert Method
- The item that should be deleted
- Set to true to stop error from binding
-
-
-
- Places the GridTableView in insert mode, allowing user to insert a new data-item
- values. The will be set to display the last
- page. You can use also the to place the
- GridTableView in insert mode.
-
-
-
-
- Places the GridTableView in insert mode, allowing the user to insert a new
- data-item values. The GridInsertItem created will be bound to values of the
- newDataItem object. The will be set to display
- the last page. You can use also the property to
- place the GridTableView in insert mode.
-
-
-
-
- Places the GridTableView in insert mode, allowing the user to insert a new
- data-item values. The GridInsertItem created will be bound to values found in
- newValues dictionary; The will be set to
- display the last page. You can use also the to
- place the GridTableView in insert mode.
-
-
-
- Gets the ClientID of the RadGrid object that contains this instance.
-
- The string representation of the ClientID object that contains the
- instance.
-
- OwnerGrid Property
-
-
- Gets or sets a value indicating whether items' data type should be
- retrieved from supplied enumerable's first item.
-
- true if this function is enabled; otherwise,
- false. The default is false.
-
-
- You should enable this property in scenarios in which the item type should not
- be retrieved from the enumerable’s generic argument but from its first item’s
- type. Such cases will be the use of various O/R Mappers where the enumerable
- is a entity base class and does not contains the actual object’s properties.
-
-
-
-
- Gets or sets the ItemTemplate, which is rendered in the control in normal
- (non-Edit) mode.
-
- A value of type System.Web.UI.CompiledBindableTemplateBuilder
-
-
-
- Gets or sets the EditItemTemplate, which is rendered in the control in edit
- mode.
-
- A value of type System.Web.UI.CompiledBindableTemplateBuilder
-
-
-
- Gets or sets the ItemTemplate, which is rendered in the control in normal
- (non-Edit) mode.
-
- A value of type System.Web.UI.CompiledBindableTemplateBuilder
-
-
-
- Gets or sets the collection of detail table views for this
- GridTableView.
-
-
- A collection of detail table views for this
- GridTableView.
-
- DataKeyValues Property
- DataKeyNames Property
-
- Adding or removing objects to the DetailTables collection changes
- the hierarchical structure.
-
- Use after modifying the collection
- programmatically.
-
- This collection can also be altered unsing the environment designer.
-
-
-
-
-
- Gets or sets a value that describes how RadGrid would respond
- if the is invalid when data-binding.
-
-
-
-
- This property is not persisted in the ViewState. By deafult the value is
- .
-
-
- GridResetPageIndexAction Enumeration
-
- A member of the GridResetPageIndexAction enumeration which
- describes how RadGrid would respond if the
- CurrentPageIndex is invalid when data-binding. By default its
- value is
-
-
-
-
- Gets or sets a value indicating whether the border lines for grid cells will be
- displayed.
-
-
- One of the
- GridLines
- values. The default is .
-
-
- Use the GridLines property to specify the gridline style for
- a GridTableView control. The following table lists the available
- styles.
-
-
-
- Style
- Description
-
-
- GridLines.None
- No gridlines are displayed.
-
-
- GridLines.Horizontal
- Displays the horizontal gridlines only.
-
-
- GridLines.Vertical
- Displays the vertical gridlines only.
-
-
- GridLines.Both
- Displays both the horizontal and vertical
- gridlines.
-
-
-
-
- CellPadding Property (Telerik.Web.UI.GridTableViewBase)
- CellSpacing Property (Telerik.Web.UI.GridTableViewBase)
-
- The following code snippet demonstrates how to use the
- GridLines property to hide the gridlines in a
- GridTableView control.
- [ASPX/ASCX]
- <radG:RadGrid ID="RadGrid1" runat="server"
- GridLines="None">
- </radGrid:RadGrid>
-
- RadGrid1.GridLines = GridLines.None
-
-
- RadGrid1.GridLines = GridLines.None;
-
-
- HorizontalAlign Property
-
-
-
- Gets or sets a value indicating the horizontal alignment of the grid
- table.
-
-
- One of the
- HorizontalAlign
- values. The default is .
-
-
- Use the HorizontalAlign property to specify the horizontal
- alignment of a GridTableView control within the page. The
- following table lists the different horizontal alignment styles.
-
-
-
- Alignment value
- Description
-
-
- HorizontalAlign.NotSet
- The horizontal alignment of the GridTableView
- control has not been set.
-
-
- HorizontalAlign.Left
- The GridTableView control is left-aligned on the
- page.
-
-
- HorizontalAlign.Center
- The GridTableView control is centered on the
- page.
-
-
- HorizontalAlign.Right
- The GridTableView control is right-aligned on the
- page.
-
-
- HorizontalAlign.Justify
- The GridTableView control is aligned with both the
- left and right margins of the page.
-
-
-
-
- GridLines Property
-
- The following code snippet demonstrates how to use the
- HorizontalAlign property to align a GridTableView
- control on the right side of a page.
- [ASPX/ASCX]
- <radG:RadGrid ID="RadGrid1" runat="server"
- HorizontalAlign="Right">
- </radG:RadGrid>
-
- RadGrid1.HorizontalAlign = HorizontalAlign.Right
-
-
- RadGrid1.HorizontalAlign = HorizontalAlign.Right;
-
-
-
-
-
-
- Gets a collection of DataKeyValue objects that represent the
- data key value of the corresponding item (specified with its
- ) and the DataKeyName
- (case-sensitive!). The DataKeyName should be one of the
- specified in the array.
-
-
-
-
- protected void RadGrid1_ItemUpdated(object source, Telerik.Web.UI.GridUpdatedEventArgs e)
- {
- if (e.Exception != null)
- {
- e.KeepInEditMode = true;
- e.ExceptionHandled = true;
- Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues[e.Item.ItemIndex]["EmployeeID"] + " cannot be updated. Reason: " + e.Exception.Message);
- }
- else
- {
- Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues[e.Item.ItemIndex]["EmployeeID"] + " updated");
- }
- }
-
-
- int eID = (int)tableView.DataKeyValues[editedItem.ItemIndex]["EmployeeID"];
-
-
- Dim eID as Integer = (CInt)tableView.DataKeyValues(editedItem.ItemIndex)("EmployeeID")
-
-
- Protected Sub RadGrid1_ItemUpdated(ByVal source As Object, ByVal e As Telerik.Web.UI.GridUpdatedEventArgs) Handles RadGrid1.ItemUpdated
- If Not e.Exception Is Nothing Then
- e.KeepInEditMode = True
- e.ExceptionHandled = True
- Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues(e.Item.ItemIndex)("EmployeeID").ToString() + " cannot be updated. Reason: " + e.Exception.Message)
- Else
- Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues(e.Item.ItemIndex)("EmployeeID").ToString() + " updated")
- End If
- End Sub
-
-
- data key name/value pair
-
- A
- GridDataKeyArray that
- contains the data key of each item in a GridTableView control.
-
-
- When the
- DataKeyNames
- property is set, the GridTableView control automatically creates a
- DataKeyValue object for each item in the control. The
- DataKeyValue object contains the values of the field or fields
- specified in the DataKeyNames property. The
- DataKeyValue objects are then added to the control's
- DataKeysValue collection. Use the DataKeysValue
- property to retrieve the DataKeyValue object for a specific data item
- in the GridTableView control.
-
-
-
-
-
- Gets or sets an array of data-field names that will be used to populate the
- collection, when the
- GridTableView
- control is databinding.
-
-
-
- Use the DataKeyNames property to specify the field or fields
- that represent the primary key of the data source.
- Note: Values set to this property are case-sensitive! The
- field names should be coma-separated.
-
- The data key names/values are stored in the ViewState so they
- are available at any moment after grid have been data-bound, after postbacks,
- etc. This collection is used when editing data, and for automatic relations
- when binding an hiararchical grid (see
- ).
-
- If the
- Visible
- property of a column field is set to false, the column is not displayed in the
- GridTableView control and the data for the column does not make a
- round trip to the client. If you want the data for a column that is not visible to
- make a round trip, add the field name to the DataKeyNames
- property.
-
-
- An array that contains the names of the primary key fields for the items
- displayed in a GridTableView control.
-
-
-
-
- This property is used to specify the field from the underlying datasource,
- which will populate the ClientDataKeyNames collection.
- This collection can later be accessed on the client, to get the key
- value(s).
- The following example demonstrates the extraction of the data key value for a
- given data table view object:
-
- <ClientSettings>
- <ClientEvents OnHierarchyExpanded="HierarchyExpanded" />
- </ClientSettings>
- <script type="text/javascript">
- function HierarchyExpanded(sender, args)
- {
- var firstClientDataKeyName =
- args.get_tableView().get_clientDataKeyNames()[0];
- alert("Item with " + firstClientDataKeyName + ":'" +
- args.getDataKeyValue(firstClientDataKeyName)
- + "' expanded.");
- }
- </script>
- The logic is placed in the OnHierarchyExpanded client side event handler,
- which is triggered when the user expands a node
- in a hierarchical grid, but can be used in any other event, given that a proper
- reference to the client table view object is obtained.
-
-
-
-
- Gets or sets values indicating DataFieldNames that should be
- sorted, grouped, etc and are not included as columns, in case the property
- is false.
-
- DataKeyValues Property
- DataKeyNames Property
-
- An array of DataFieldNames values that should be sorted, grouped, etc and are not
- included as columns.
-
- RetrieveAllDataFields Property
-
-
-
- Gets or sets a value indicating whether RadGrid will show
- instead of the corresponding
- if there is no items to display.
-
-
- true if usage is enabled;
- otherwise, false. The default value is true.
-
- NoRecordsTemplate Property
- NoMasterRecordsText Property
- NoDetailRecordsText Property
-
-
-
- Gets or sets the template that will be displayed if a
- GridTableView
- control is bound to a data source that does not contain any records.
-
-
-
- You can set the text that will appear in the NoRecordsTemplate through
- NoMasterRecordsText and
- NoDetailRecordsText properties.
-
- By default if Items.Count equals 0,
- GridTableView will render no records message.
- If NoRecordsTemplate and
- NoMasterRecordsText/NoDetailRecordsText are set,
- the NoRecordsTemplate property has priority.
-
-
- A
- System.Web.UI.ITemplate
- that contains the custom content for the empty data row. The default value is a
- null reference (Nothing in Visual Basic), which indicates that
- this property is not set.
-
-
- The following example demonstrates how NoRecordsTemplate can
- be implemented declaratively:
- [ASPX/ASCX]
- <radG:RadGrid ID="RadGrid1" runat="server">
- <MasterTableView>
- <NoRecordsTemplate>
- <div style="text-align: center; height: 300px">
- <asp:Label ForeColor="RoyalBlue" runat="server" ID="Label1">Currently there
- are no items in this folder.</asp:Label>
- <br />
- </div>
- </NoRecordsTemplate>
- </MasterTableView>
- </radG:RadGrid>
- The following code snippet demonstrates how the NoRecordsTemplate can be
- implemented dynamically:
-
- RadGrid1.MasterTableView.NoRecordsTemplate = New NoRecordsTemplate()
-
- Public Class NoRecordsTemplate
- Implements ITemplate
-
- Public Sub New()
- End Sub
-
- Public Sub InstantiateIn(ByVal container As System.Web.UI.Control) Implements System.Web.UI.ITemplate.InstantiateIn
- Dim lbl As Label = New Label()
- lbl.ID = "Label1"
- lbl.Text = "Currently there are no items in this folder."
- lbl.ForeColor = System.Drawing.Color.RoyalBlue
- container.Controls.Add(lbl)
- End Sub
- End Class
-
-
- RadGrid1.MasterTableView.NoRecordsTemplate = new NoRecordsTemplate();
-
- class NoRecordsTemplate: ITemplate
- {
- public NoRecordsTemplate()
- {
- }
-
- public void InstantiateIn(Control container)
- {
- Label lbl = new Label();
- lbl.ID = "Label1";
- lbl.Text = "Currently there are no items in this folder.";
- lbl.ForeColor = System.Drawing.Color.RoyalBlue;
- container.Controls.Add(lbl);
- }
- }
-
-
-
- The
-
- EnableNoRecordsTemplate Property should be set to true (its
- default value) in order to be displayed the
- NoRecordsTemplate.
-
- EnableNoRecordsTemplate Property
- NoMasterRecordsText Property
- NoDetailRecordsText Property
-
-
-
- Gets or sets the text that will be displayed in there is no
- defined and no records in the
- MasterTableView.
-
- EnableNoRecordsTemplate Property
- NoRecordsTemplate Property
- NoDetailRecordsText Property
-
- The text to display in the empty data item. The default is an empty string ("")
- which indicates that this property is not set.
-
-
- The empty data row is displayed in a GridTableView control when
- the data source that is bound to the control does not contain any records. Use the
- NoMasterRecordsText and NoDetailRecordsText property
- to specify the text to display in the empty data item. Alternatively, you can define
- your own custom user interface (UI) for the empty data item by setting the
- NoRecordsTemplate property instead of this property.
-
-
-
-
- Gets or sets the text that will be displayed in there is no
- defined and no records in the Detail tables.
-
-
- The text to display in the empty data item. The default is an empty string (""),
- which indicates that this property is not set.
-
-
- The empty data row is displayed in a GridTableView control when
- the data source that is bound to the control does not contain any records. Use the
- NoMasterRecordsText and NoDetailRecordsText property
- to specify the text to display in the empty data item. Alternatively, you can define
- your own custom user interface (UI) for the empty data item by setting the
- NoRecordsTemplate property instead of this property.
-
- EnableNoRecordsTemplate Property
- NoRecordsTemplate Property
- NoMasterRecordsText Property
-
-
-
- Gets or sets a value indicating whether the GridTableView
- will extract all bindable properties from the DataSource when
- binding, to perform operations like sorting, grouping, etc on DataFields that are
- not included in the column declarations.
-
-
- You can also use the array to indicate
- RadGrid DataFieldNames that should be sorted, grouped, ect and are
- not included as columns.
-
-
- true, if the GridTableView will extract all
- bindable properties from the DataSource when binding; otherwise,
- false. The default value is true.
-
- AdditionalDataFieldNames Property
-
-
-
- Gets or sets a value indicating whether the GridTableView
- should use all retieved properties from the DataSource when
- binding, to perform operations like sorting, grouping, etc on DataFields that are
- not included in the column declarations.
-
-
- You can also use the array to indicate
- RadGrid DataFieldNames that should be sorted, grouped, ect and are
- not included as columns.
-
-
- false, if the GridTableView will not use all
- bindable properties from the DataSource when binding; otherwise,
- true. The default value is false.
-
- AdditionalDataFieldNames Property
-
-
-
- Gets or sets a value indicating whether null values in the
- database will be retrieved as dbnull values.
-
-
- true if the null values in the database
- will be retrieved as dbnull values; otherwise,
- false. The default is false.
-
-
-
-
- Gets or sets the collection of data-field pairs that describe the relations in a
- hierarchical grid.
-
-
- If you have specified the relations RadGrid will automatically
- filter the child data-source when when binding detail-tables. The specified
- in each
- in this collection should be a Key that is
- specified in the parent table's array. Each
- DetailKeyField specfied should also be included in this
- GridTableView's DataKeyNames array.
- MasterTableView does not need any
- ParentTableRelations.
-
-
- A GridTableViewRelation collection of data-field pairs that
- describe the relations in a hierarchical grid.
-
- GridTableViewRelation Class
- DataKeyValues Property
- DataKeyNames Property
- Hierarchy online example
-
-
-
- Gets a set the options for GridTableView's self-hierarchy
- behavior.
-
- GridSelfHierarchySettings Class
- Options for GridTableView's self-hierarchy behavior.
- Self-referencing hierarchy online example
-
-
-
- Gets a set of options for the GridTableView's data-bound
- nested view template.
-
-
-
- Gets a set the options for GridTableView's command item.
- The options for GridTableView's command item.
- GridCommandItemSettings Class
- CommandItemDisplay Property
-
-
-
- Gets or sets the object from which the data-bound control retrieves its list
- of data items.
-
-
-
- Generally the DataSource object references
- . Assign this property only if you need to
- change the default behavior or .
-
-
- RadGrid modifies this property when
- is assigned.
-
- On postback the DataSource property settings are not
- persisted due to performance reasons. Note, however, that you can save the grid
- DataSource in a Session/Application/Cache
- variable and then retrieve it from there after postback invocation. Respectively,
- you can get the changes made in the data source in a dataset object and then
- operate with them.
- This property cannot be set by themes or style sheet themes.
-
-
- An object that represents the data source from which the
- GridTableView control retrieves its data. The default is a null
- reference (Nothing in Visual Basic).
-
- DataSourceID Property
- Simple data-binding online example
- Various data sources online example
- GridNeedDataSourceEventHandler Delegate
-
-
-
- Gets or sets the ID of the DataSource control used for
- population of this GridTableView data items.
-
-
- [ASPX/ASCX]
- <radG:RadGrid ID="RadGrid1" runat="server"
- DataSourceID="SessionDataSource1">
- ............
- </radG:RadGrid>
-
-
- The ID of a control that represents the data source from which the data-bound
- control retrieves its data. The default is String.Empty ("").
-
- This property cannot be set by themes or style sheet themes.
- DataSource Property
- GridNeedDataSourceEventHandler Delegate
-
-
-
- Gets a reference to a GridItem that is a parent of this
- GridTableView, when this GridTableView represents a
- child table in a hierarchical structure.
-
- A reference to the server control's parent control.
-
- Whenever a page is requested, a hierarchy of server controls on that page is
- built. This property allows you to determine the parent control of the current server
- control in that hierarchy, and to program against it.
-
-
- Whenever a page is requested, a hierarchy of server controls on that page is
- built. This property allows you to determine the parent control of the current server
- control in that hierarchy, and to program against it.
-
- GridItem Class
-
-
- Gets or sets the filtering options for grid columns.
-
- In the most common case, Telerik RadGrid checks all filtering options
- for each column, then prepares a filter expression and sets this property internally.
- Note: You should be careful when setting this property as it may
- break the whole filtering functionality for your grid.
- More info on the way, the expressions are created you can find
-
- here (external link to MSDN library).
-
-
-
- If (Not Page.IsPostBack) Then
- RadGrid1.MasterTableView.FilterExpression = "([Country] LIKE '<see cref="Germany"/>') "
-
- Dim column As GridColumn = RadGrid1.MasterTableView.GetColumnSafe("Country")
- column.CurrentFilterFunction = GridKnownFunction.Contains
- column.CurrentFilterValue = "Germany"
- End If
-
-
- if (!Page.IsPostBack)
- {
- RadGrid1.MasterTableView.FilterExpression = "([Country] LIKE \'<see cref="Germany"/>\') ";
-
- GridColumn column = RadGrid1.MasterTableView.GetColumnSafe("Country");
- column.CurrentFilterFunction = GridKnownFunction.Contains;
- column.CurrentFilterValue = "Germany";
- }
-
-
- Applying default filter on initial load
-
-
-
- Gets or sets a value indicating whether the groups will be expanded on grid load
- (true by default).
-
-
- true, if the groups will be expanded on grid load; otherwise,
- false. The default value is true.
-
- GroupLoadMode Property
- GroupByExpressions Property
-
-
-
- Gets or sets a value indicating whether the hierarchy will be expanded by
- default.
-
-
-
-
- Gets a reference to the object, allowing
- you to customize its settings.
-
- The property setter does nothing and should not be used. It works around a bug in the VS.NET designer.
-
-
-
- Gets a reference to the object, allowing
- you to customize its settings.
-
- The property setter does nothing and should not be used. It works around a bug in the VS.NET designer.
-
-
-
-
- Gets or sets a value indicating when the DataBind of the child
- GridTableView will occur when working in hierarchy mode.
- Accepts values from enumeration. See the
- remars for details.
-
-
-
- Changing this propery value impacts the performance the following way:
-
- In ServerBind mode - Roundtrip to the database only when
- grid is bound. ViewState holds all detail tables data. Only detail table-views
- of the expanded items are rendered. Postback to the server to expand an
- item
- In ServerOnDemand mode - Roundtrip to the database when
- grid is bound and when item is expanded. ViewState holds data for only visible
- Items (smallest possible). Only detail table-views of the expanded items are
- rendered. Postback to the server to expand an item.
- In Client mode - Roundtrip to the database only when
- grid is bound. ViewState holds all detail tables data. All items are rendered -
- even is not visible (not expanded). NO postback to the server to expand an item
- - expand/collapse of hierarchy items is managed client-side.
- Note: In order to use client-side hierarchy expand, you will
- need to set also
-
- to true.
-
-
- The default value is ServerOnDemand.
-
-
-
- Specifies where the grouping will be handled. There are two options:
-
- Server-side - GridTableView.GroupLoadMode.Server
- Client-side -
- GridTableView.GroupLoadMode.Client
-
-
- GridTableView.GroupLoadMode.Server
- This is the default behavior. Groups are expanded after postback to the server
- for example:
-
-
-
-
-
-
-
- <MasterTableView GroupLoadMode="Server">
-
-
-
- GridTableView.GroupLoadMode.Client
-
Groups will be
- expanded client-side and no postback will be performed.
-
-
-
-
-
-
-
- <MasterTableView GroupLoadMode="Client">
-
-
- and set the client setting AllowGroupExpandCollapse to
- true:
-
-
-
-
-
- There are two possible values defined by the GridEditMode
- enumeration:
-
- InPlace
- EditForms
-
- To display the grid column editors inline when switching grid item in edit
- mode (see the screenshot below), you simply need to change the
- EditMode property to InPlace.
-
-
- To display the grid column editors in auto-generated form when switching grid
- item in edit mode (see the screenshot below), you simply need to change the
- MasterTableView EditMode property to
- EditForms.
-
-
-
- FormsGets or sets a value indicating how a GridItem will
- look in edit mode.
-
-
- A value indicating how a GridItem will look in edit mode. The
- default is EditForms.
-
- GridEditMode Enumeration
-
-
-
- Gets or sets the value indicating wheather more than one column can be sorted in a
- single GridTableView. The order is the same as the sequence of
- expressions in .
-
-
- true, if more than one column can be sorted in a single
- GridTableView; otherwise, false. The default value is
- false.
-
- AllowSorting Property
- SortExpressions Property
-
-
-
- Gets or sets the value indicated whether the no-sort state when changing sort
- order will be allowed.
-
-
- true, if the no-sort state when changing sort order will be
- allowed; otherwise, false. The default value is
- true.
-
- SortExpressions Property
- AllowSorting Property
-
-
-
- Gets or sets a value indicating whether the sorting feature is
- enabled.
-
-
-
- true if the sorting feature is enabled; otherwise,
- false. The default is .
-
-
- SortExpressions Property
- AllowCustomSorting Property
- AllowMultiColumnSorting Property
-
- When a data source control that supports sorting is bound to the
- GridTableView
- control, the GridTableView control can take advantage of the data
- source control's capabilities and provide automatic sorting functionality.
- To enable sorting, set the AllowSorting property to
- true. When sorting is enabled, the heading text for each column
- field with its
- SortExpressions
- property set is displayed as a link button.
- Clicking the link button for a column causes the items in the
- GridTableView control to be sorted based on the sort expression.
- Typically, the sort expression is simply the name of the field displayed in the
- column, which causes the GridTableView control to sort with
- respect to that column. To sort by multiple fields, use a sort expression that
- contains a comma-separated list of field names. You can determine the sort
- expression that the GridTableView control is applying by using the
- SortExpressions property. Clicking a column's link button repeatedly toggles the
- sort direction between ascending and descending order.
- Note that if you want to sort the grid by a column different
- than a GridBoundColumn, you should set also its
- SortExpression
- property to the desired data field name you want the column to be sorted by.
-
-
- Different data sources have different requirements for enabling their sorting
- capabilities. To determine the requirements, see the documentation for the specific
- data source.
- The SortExpression property for an automatically generated
- columns field is automatically populated. If you define your own columns through
- the Columns
- collection, you must set the SortExpression property for each
- column; otherwise, the column will not display the link button in the
- header.
-
- AllowNaturalSort Property
- SortExpressions Property
-
-
-
- Gets or sets a value indicating whether the filtering by column feature is
- enabled.
-
-
-
- true if the filtering by column feature is enabled; otherwise,
- false. Default value is the value of
- .
-
-
-
-
- When the value is true, GridTableView will display the
- filtering item, under the table's header item. The filtering can be controlled
- based on a column through column properties:
- ,
- ,
- . The column
- method is used to determine if
- a column can be used with filtering. Generally, this function returns the value
- set to AllowFiltering for a specific column. For example
- will return the values of
- property.
-
-
- GridFilteringItem Class
- Basic filtering online example
-
-
-
- Gets or sets a value indicating whether the header context menu should be
- enabled.
-
-
-
- true if the header context menu feature is enabled; otherwise,
- false. Default value is the value of
- .
-
-
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will
- automatically generate columns at runtime based on its
- DataSource.
-
-
-
- A value indicating whether Telerik RadGrid will automatically
- generate columns at runtime based on its DataSource. The
- default value is the value of RadGrid's property
- .
-
-
- AutoGeneratedColumns Property
-
-
- For internal usage.
-
-
-
-
-
-
- Gets all items among the hierarchy of
- GridTableView
- items that are selected. The selected items in a GridTableView
- are cleared when collapses and the
- ParentItem becomes selected.
-
-
-
- A GridItemCollection of items among the hierarchy of
- GridTableView items that are selected.
-
- GridItemCollection Class
-
-
-
-
- Gets all items among the hierarchy of
- GridTableView
- items that are in edit mode. The edit items in a GridTableView
- are cleared when collapses.
-
-
- A GridItemCollection of items that are in edit mode.
- GridItemCollection Class
- EditMode Property
- EditFormSettings Property
-
-
-
- Gets or sets a value indicating whether all columns settings will be persisted in
- the ViewState or not.
-
-
- true if columns are kept in the view state; otherwise
- false. The default value is true.
-
-
- Set this property to false if you need to change dynamically the
- structure of the RadGrid.
-
-
-
- Gets or sets if the custom sorting feature is enabled.
-
- With custom sorting turned on, RadGrid will display as Sorting Icons, will maintain
- the SortExpressions collection and so on, but it will not actually sort the Data.
- You should perform the custom sorting in the SortCommand event handler. You can
- also use the method,
- which will return the sort expressions string in the same format as it wold be used
- by a DataView component.
-
-
- true, if custom sorting feature is enabled; otherwise,
- false. The default value is false.
-
- AllowSorting Property
- SortExpressions Property
- GridSortCommandEventHandler Delegate
-
-
- Gets or sets if the custom paging feature is enabled.
-
- true, if the custom paging feature is enabled; otherwise,
- false. Default value is the value of
- .
-
- AllowPaging Property
- Custom paging online example
-
- There are cases in which you may want to fetch only a fixed number of records and
- perform operations over this specified set of data. Telerik RadGrid allows such
- data manipulation through the custom paging mechanism integrated in the control.
- The main steps you need to undertake are:
-
- Set AllowPaging = true and AllowCustomPaging = true for
- your grid instance
- Implement code logic which to extract merely a fixed number of records
- from the grid source and present them in the grid structure
- The total number of records in the grid source should be defined through
- the VirtualItemCount property of the MasterTableView/GridTableView
- instance. Thus the grid "understands" that the data source contains the
- specified number of records and it should fetch merely part of them at a time
- to execute requested operation.
- Another available option for custom paging support is through the
- ObjectDataSource control custom paging feature:
-
- Custom paging with ObjectDataSource grid content generator
-
-
-
- Gets or sets a value indicating whether the paging feature is enabled.
-
-
- true if the paging feature is enabled; otherwise,
- false. The default is .
-
-
- PageCount Property
- PageSize Property
- PagingManager Property
- PagerStyle Property
- RenderPagerStyle Property
- PagerTemplate Property
- CurrentPageIndex Property
- CurrentResetPageIndexAction Property
-
- Instead of displaying all the records in the data source at the same time,
- the GridTableView
- control can automatically break the records up into pages. If the data source
- supports the paging capability, the GridTableView control can take
- advantage of that and provide built-in paging functionality. The paging feature can
- be used with any data source object that supports the
- System.Collections.ICollection interface or a data source that supports
- paging capability.
- To enable the paging feature, set the AllowPaging property
- to true. By default, the GridTableView control
- displays 10 records on a page at a time. You can change the number of records
- displayed on a page by setting the
- PageSize
- property. To determine the total number of pages required to display the data
- source contents, use the
- PageCount
- property. You can determine the index of the currently displayed page by using the
- CurrentPageIndex
- property.
- When paging is enabled, an additional row called the pager item is
- automatically displayed in the GridTableView control. The pager
- row contains controls that allow the user to navigate to the other pages. You can
- control the settings of the pager row (such as the pager display mode, the number
- of page links to display at a time, and the pager control's text labels) by using
- the
- PagerStyle
- properties. The pager row can be displayed at the top, bottom, or both the top and
- bottom of the control by setting the
- Position
- property. You can also select from one of six built-in pager display modes by
- setting the Mode
- property.
- The GridTableView control also allows you to define a custom
- template for the pager row. For more information on creating a custom pager row
- template, see
- PagerTemplate.
- The GridTableView control provides an event that you can use
- to perform a custom action when paging occurs.
-
-
-
- Event
- Description
-
-
-
-
-
- Occurs when one of the pager buttons is clicked, but after
- the GridTableView control handles the paging operation. This
- event is commonly used when you need to perform a task after the user
- navigates to a different page in the control.
-
-
-
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid should retrieve all data and ignore server paging in case of filtering or grouping.
-
-
- true (default) if the retrieve all data feature is enabled; otherwise,
- false.
-
-
-
-
-
-
- Specify the maximum number of items that would appear in a page, when paging is
- enabled by or
- property. Default value is the value of
- .
-
-
- The number of records to display on a single page. The default is 10.
- The PageSize property is set to a value less than 1.
-
- When the paging feature is enabled (by setting the
- AllowPaging
- property to true), use the PageSize property to specify the number of
- records to display on a single page.
-
- The number of records to display on a single page. The default is 10.
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will perform
- automatic updates, i.e. using the DataSource controls
- functionality.
-
-
- true, if Telerik RadGrid will perform automatic
- updates; otherwise, false. The default value is
- false.
-
- Automatic operations online example
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will perform
- automatic inserts, i.e. using the DataSource controls
- functionality.
-
-
- true, if the Telerik RadGrid will perform automatic
- inserts; otherwise, false. The default value is
- false.
-
- Automatic operations online example
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will perform
- automatic deletes, i.e. using the DataSource controls
- functionality.
-
-
- true, if Telerik RadGrid will perform automatic
- deletes; otherwise, false. The default value is
- false.
-
- Automatic operations online example
-
-
-
- Gets a collection of
- GridColumn objects
- that represent the column fields in a
- GridTableView
- control.
-
-
- A
- GridColumnCollection
- that contains all the column fields in the GridTableView
- control.
-
-
- A column field represents a column in a GridTableView
- control. The Columns property (collection) is used to store all
- the explicitly declared column fields that get rendered in the GridTableView
- control. You can also use the Columns collection to
- programmatically manage the collection of column fields.
- The column fields are displayed in the GridTableView control
- in the order that the column fields appear in the Columns
- collection.
-
- To get a list of all columns rendered in the current instance use
-
-
- Although you can programmatically add column fields to the
- Columns collection, it is easier to list the column fields
- declaratively in the GridTableView control and then use the
- Visible
- property of each column field to show or hide each column field.
- If the Visible property of a column field is set to false,
- the column is not displayed in the GridTableView control and the
- data for the column does not make a round trip to the client. If you want the data
- for a column that is not visible to make a round trip, add the field name to the
- DataKeyNames
- property.
- This property can be managed programmatically or by Property Builder (IDE
- designer).
-
-
- Explicitly declared column fields can be used in combination with automatically
- generated column fields. When both are used, explicitly declared column fields are
- rendered first, followed by the automatically generated column fields. Automatically
- generated column fields are not added to the Columns
- collection.
-
- GridColumnCollection Class
- GridColumn Class
- Column types online example
-
-
-
- Gets the number of pages required to display the records of the data source
- in a GridTableView
- control.
-
- The number of pages in a GridTableView control.
-
- When the paging feature is enabled (by setting the
- AllowPaging
- Property to true), use the PageCount property to
- determine the total number of pages required to display the records in the data source.
- This value is calculated by dividing the total number of records in the data source by
- the number of records displayed in a page (as specified by the
- PageSize
- property) and rounding up.
-
- AllowPaging Property
- AllowCustomPaging Property
- PageSize Property
- PagingManager Property
- PagerStyle Property
- PagerTemplate Property
-
-
- Gets the number of pages if paging is enabled.
- The number of pages if paging is enabled.
- AllowPaging Property
- AllowCustomPaging Property
-
-
-
- Gets a DataView object that represents the data sent to the
- to be displayed.
-
- A result DataView object of all grid operations.
-
- ResolvedDataSourceView is available only in event
- handler i.e. when the grid is bound.
-
-
-
-
- Gets a Paging object that is the result of paging settings and runtime paging
- state of the grid.
-
-
- A
- GridPagingManager
- object that corresponds to the Paging object.
-
-
- Note that changes made to this object would not have
- effect on the structure of the grid.
-
- AllowPaging Property
- PageSize Property
- PageCount Property
-
-
-
- Gets a collection of sort expressions for this table view instance, associated
- with the column or columns being sorted.
-
-
-
- Modifying the SortExpressions collection will result in change
- of the order of appearance of items in the table view. If
- is set to false this collection can
- only contain one item. Adding other in
- the collection in this case will cause existing expression to be deleted or if
- GridSortExpression with the same same
- exist its
- will be changed.
-
- This property's value is preserved in the ViewState.
-
- GridSortExpressionCollection Class
- AllowSorting Property
- AllowCustomSorting Property
- AllowMultiColumnSorting Property
-
- The collection of sort expressions associated with the column or columns being
- sorted.
-
- Advanced sorting online example
-
-
-
- Adding to this collection will cause the
- current table-view to display items sorted and devided in groups separated by
- s, that display common group and aggregate
- field values. See on details of
- expressions syntax.
-
-
- Note that the correctness of the expressions in the collection is
- checked when DataBind occures. Then if an expression in not correct or a
- combination of expressions is erroneous a
- would be thrown on . This property's value is preserved
- in the ViewState.
-
-
- A GroupByExpressionCollection of values that will cause the current table-view to
- display items sorted and devided in groups separated by
- GridGroupHeaderItems, that display common group and aggregate field
- values.
-
- Group-By expressions online example
-
-
-
-
-
-
-
- Get an array of automatically generated columns. This array is available when
- is set to true. Autogenerated
- columns appear always after when rendering.
-
- An array of automatically generated columns.
-
-
-
- Gets a value defining the setting that will be applied when an Item is in edit
- mode and the property is set to
- EditForms.
-
-
- [ASPX/ASCX]
- <MasterTableView>
- <EditFormSettings
- CaptionFormatString='<img src="img/editRowBg.gif" alt=""
- />'>
- <FormMainTableStyle GridLines="None"
- CellSpacing="0"
- CellPadding="3"
- Width="100%"
- CssClass="none"/>
- <FormTableStyle CssClass="EditRow"
- CellSpacing="0"
- BorderColor="#c4c0b5"
- CellPadding="2"
- Width="100%"/>
- <FormStyle Width="100%"
- BackColor="#ffffe1"></FormStyle>
- </EditFormSettings>
-
- GridEditFormSettings Class
-
-
-
- Gets or sets a string that specifies a brief description of a
- GridTableView.
- Related to Telerik RadGrid accessibility compliance.
-
-
- A string that represents the text to render in an HTML caption element in a
- GridTableView control. The default value is an empty string
- ("").
-
-
- Use the Caption property to specify the text to render in an
- HTML caption element in a GridTableView control. The text that you
- specify provides assistive technology devices with a description of the table that
- can be used to make the control more accessible.
-
- Summary Property
-
-
- The following example demonstrates how to style the Caption of a MasterTableView and detail GridTableView.
-
-
-
-
- Gets or sets the 'summary' attribute for the respective table.
-
- This attribute provides a summary of the table's purpose and structure for user
- agents rendering to non-visual media such as speech and Braille. This property is a
- part of Telerik RadGrid accessibility features.
-
-
- A string representation of the 'summary' attribute for the respective
- table.
-
- Caption Property
-
-
-
- Gets or sets the text direction. This property is related to Telerik RadGrid support
- for Right-To-Left lanugages. It has two possible vales defined by
- enumeration:
-
- LTR - left-to-right text
- RTL - right-to-left text
-
-
-
-
- The frame attribute for a table specifies which sides of the frame surrounding
- the table will be visible. Possible values:
-
- void: No sides. This is the default
- value.
- above: The top side only.
- below: The bottom side only.
- hsides: The top and bottom sides only.
- vsides: The right and left sides only.
- lhs: The left-hand side only.
- rhs: The right-hand side only.
- box: All four sides.
- border: All four sides
-
- Gets or sets a value specifying the frame table attribute.
-
- A
- GridTableFrame value,
- specifying the frame table attribute.
-
- GridTableFrame Enumeration
-
-
- GridTableLayout Enumeration
-
-
- A
- GridTableLayout
- value, indicating the table layout type. The default value is
- .
-
-
- Gets or sets a string that indicates whether the table layout is fixed.
-
-
- The value of the TableLayout property is a string that
- specifies or receives one of the following GridTableLayout
- enumeration values:
-
-
- Auto
- Column width is set by the widest unbreakable content in
- the column cells.
-
-
- Fixed
-
- Default. Table and column widths are set either by the sum of the
- widths on the objects or, if these are
- not specified, by the width of the first row of cells. If no width
- is specified for the table, it renders by default with width=100%.
-
-
-
-
-
-
-
-
- Gets a reference to the
- GridTableItemStyle
- object that allows you to set the appearance of items in a
- GridTableView
- control.
-
-
- A reference to the GridTableItemStyle that represents the style of
- data items in a GridTableView control. If style is not altered (is
- default) is used.
-
- AlternatingItemStyle Property
- CommandItemStyle Property
- FooterStyle Property
- HeaderStyle Property
- SelectedItemStyle Property
-
-
- Gets the rendering style of an Item.
-
- A reference to the GridTableItemStyle that represents the
- rendering style of the item. If is not specified the
- return value is OwnerGrid..
-
- GridTableItemStyle Class
-
-
- Manage visual style of the group header items.
-
- A reference to the GridTableItemStyle that represents the style of
- the group header items. If style is not altered (is default)
- is used.
-
- GridTableItemStyle Class
-
-
- Gets the rendering style of the group header items.
-
- A reference to the GridTableItemStyle that represents the
- rendering style of the group header items. If
- is not specified the return value is
- OwnerGrid..
-
- GridTableItemStyle Class
-
-
-
- Gets a reference to the
- GridTableItemStyle
- object that allows you to set the appearance of alternating items in a
- GridTableView
- control.
-
-
- A reference to the GridTableItemStyle that represents the style of
- alternating data items in a GridTableView control. If style is not
- altered (is default) is used.
-
-
- Use the AlternatingItemStyle property to control the
- appearance of alternating items in a GridTableView control. When
- this property is set, the items are displayed alternating between the
- ItemStyle
- settings and the AlternatingItemStyle settings. This property is
- read-only; however, you can set the properties of the
- GridTableItemStyle object it returns. The properties can be set
- declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the
- GridTableView control in the form
- Property-Subproperty, where Subproperty is a
- property of the GridTableItemStyle object (for example,
- AlternatingItemStyle-ForeColor).
- Nest an <AlternatingItemStyle> element between the opening and
- closing tags of the GridTableView control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example,
- AlternatingItemStyle.ForeColor). Common settings usually include a custom
- background color, foreground color, and font properties.
-
- GridTableItemStyle Class
-
-
- Gets the rendering style of the AlternatingItem.
- GridTableItemStyle Class
-
- A reference to the GridTableItemStyle that represents the
- rendering style of the AlternatingItem. If
- is not specified the return value is
- OwnerGrid..
-
-
-
-
- Gets a reference to the
- GridTableItemStyle
- object that allows you to set the appearance of the item selected for editing in a
- GridTableView
- control.
-
-
-
- A reference to the GridTableItemStyle that represents the
- style of the row being edited in a GridTableView control. If style is not
- altered (is default) is used.
-
-
-
- Use the EditItemStyle property to control the appearance of
- the item in edit mode. This property is read-only; however, you can set the
- properties of the GridTableItemStyle object it returns. The
- properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the
- GridTableView control in the form
- Property-Subproperty, where Subproperty is a
- property of the GridTableItemStyle object (for example,
- EditItemStyle-ForeColor).
- Nest an <EditItemStyle> element between the
- opening and closing tags of the GridTableView control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example,
- EditItemStyle.ForeColor). Common settings usually include a custom
- background color, foreground color, and font properties.
-
- ItemStyle Property
- GroupHeaderItemStyle Property
- AlternatingItemStyle Property
- PagerStyle Property
- HeaderStyle Property
- FilterItemStyle Property
- CommandItemStyle Property
- FooterStyle Property
- SelectedItemStyle Property
- GridTableItemStyle Class
-
-
- Gets the rendering style of an edit Item.
-
- A reference to the GridTableItemStyle that represents the
- rendering style of an edit item. If is not
- specified the return value is OwnerGrid..
-
- GridTableItemStyle Class
-
-
-
- Gets a reference to the
- GridPagerStyle object
- that allows you to set the appearance of the pager item in a
- GridTableView
- control.
-
-
- A reference to the GridPagerStyle that represents the style of the
- pager item in a GridTableView control. If style is not altered (is
- default) is used.
-
-
- Use the PagerStyle property to control the appearance of the
- pager item in a GridTableView control. The pager item is displayed
- when the paging feature is enabled (by setting the AllowPaging
- property to true) and contains the controls that allow the user to
- navigate to the different pages in the control. This property is read-only;
- however, you can set the properties of the GridPagerStyle object it returns. The
- properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the
- GridTableView control in the form
- Property-Subproperty, where Subproperty is a
- property of the GridPagerStyle object (for example,
- PagerStyle-ForeColor).
- Nest a <PagerStyle> element between the opening
- and closing tags of the GridTableView control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example,
- PagerStyle.ForeColor). Common settings usually include a custom
- background color, foreground color, and font properties.
-
- ItemStyle Property
- AlternatingItemStyle Property
- HeaderStyle Property
- FooterStyle Property
- SelectedItemStyle Property
- GridTableItemStyle Class
- Styling Header, Footer and Pager items online example
-
-
- Gets the rendering style of the Pager item.
-
- A reference to the GridTableItemStyle that represents the rendering style of the
- pager item. If is not specified the return value is
- OwnerGrid..
-
- GridTableItemStyle Class
-
-
-
- Gets a reference to the
- GridTableItemStyle
- object that allows you to set the appearance of the header item in a
- GridTableView
- control.
-
-
-
- A reference to the GridTableItemStyle that represents the
- style of the header row in a GridTableView control. If style
- is not altered (is default) is used.
-
-
-
- Use the HeaderStyle property to control the appearance of
- the header item in a GridTableView control. This property is
- read-only; however, you can set the properties of the
- GridTableItemStyle object it returns. The properties can be set
- declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the
- GridTableView control in the form
- Property-Subproperty, where Subproperty is a
- property of the GridTableItemStyle object (for example,
- HeaderStyle-ForeColor).
- Nest a <HeaderStyle> element between the opening
- and closing tags of the GridTableView control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example,
- HeaderStyle.ForeColor). Common settings usually include a custom
- background color, foreground color, and font properties.
-
- ItemStyle Property
- AlternatingItemStyle Property
- EditItemStyle Property
- FooterStyle Property
- SelectedItemStyle Property
- GridTableItemStyle Class
- Styling Header, Footer and Pager items online example
-
-
- Gets the rendering style of a GridHeaderItem.
-
- A reference to the GridTableItemStyle that represents the rendering style of the
- GridHeaderItem. If is not specified the return value
- is OwnerGrid..
-
- GridTableItemStyle Class
-
-
-
- Gets a reference to the
- GridTableItemStyle
- object that allows you to set the appearance of the filter item in a
- GridTableView
- control.
-
-
- A reference to the GridTableItemStyle that represents the style
- of the filter item.
-
- GridTableItemStyle Class
-
-
- Gets the rendering style of a FilterItem.
-
- A reference to the GridTableItemStyle that represents the
- rendering style of a FilterItem. If is not
- specified the return value is OwnerGrid.
-
- GridTableItemStyle Class
-
-
-
- Gets a referenct to the
- GridTableItemStyle
- object that allows you to set the appearance of the command item in a
- GridTableView
- control.
-
-
- A reference to the GridTableItemStyle that represents the style
- of the command item.
-
- GridTableItemStyle Class
-
-
- Gets the rendering style of a CommandItem.
-
- A reference to the GridTableItemStyle that represents the
- rendering style of a CommandItem. If is not
- specified the return value is
- OwnerGrid..
-
- GridTableItemStyle Class
-
-
- Gets the rendering style of an ActiveItem.
-
- A reference to the GridTableItemStyle that represents the
- rendering style of an ActiveItem.
-
- GridTableItemStyle Class
-
-
- Manage visual style of the footer item.
-
- A reference to the GridTableItemStyle that represents the style of
- the footer item. If style is not altered (is default)
- is used.
-
- GridTableItemStyle Class
- Styling Header, Footer and Pager items online example
-
-
- Gets the rendering style of an FooterItem.
-
- A reference to the GridTableItemStyle that represents the
- rendering style of an FooterItem. If is not
- specified the return value is OwnerGrid..
-
- GridTableItemStyle Class
-
-
-
- Gets a reference to the
- Style object that allows you to set the appearance of the selected item
- in a GridTableView
- control.
-
-
-
- A reference to the Style object that represents the style of
- the selected item in a GridTableView control. If style is not
- altered (is default) is used.
-
-
-
- Use the SelectedItemStyle property to control the appearance
- of the selected item in a GridTableView control. This property is read-only;
- however, you can set the properties of the Style object it
- returns. The properties can be set declaratively using one of the following
- methods:
-
- Place an attribute in the opening tag of the
- GridTableView control in the form
- Property-Subproperty, where Subproperty is a
- property of the Style object (for example,
- SelectedItemStyle-ForeColor).
- Nest a <SelectedRowStyle> element between the
- opening and closing tags of the GridTableView control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example,
- SelectedItemStyle.ForeColor). Common settings usually include a
- custom background color, foreground color, and font properties.
-
-
- The following code example demonstrates how to use the
- SelectedItemStyle property to define a custom style for the
- selected item in a GridTableView control.
- [ASPX/ASCX]
- <radG:RadGrid ID="RadGrid1" runat="server">
- ..........
- <SelectedItemStyle BackColor="#FFE0C0" />
- </radG:RadGrid>
-
- RadGrid1.SelectedItemStyle.BackColor = System.Drawing.Color.Azure
-
-
- RadGrid1.SelectedItemStyle.BackColor = System.Drawing.Color.Azure;
-
-
- ItemStyle Property
- AlternatingItemStyle Property
-
-
-
- Gets or sets the name of the
- GridTableView.
-
-
- The string representation of the Name of the GridTableView it is
- assigned to. The default is String.Empty ("").
-
-
- The Name property can be used distinguish different
- GridTableView instances. Often used to set different settings for
- different views conditionally.
-
-
- The following example demonstrates different action on
- [ASPX/ASCX]<script type="text/javascript" >
- function OnRowDblClick(index)
- {
- if(this.Name == "MasterTableView")
- {
- alert("Cliecked row with index " + index + " of the MasterTableView");
- }
- if(this.Name == "DetailTableView1")
- {
- alert("Clicked row with index " + index + " of the first detail table");
- }
- if(this.Name == "DetailTableView2")
- {
- alert("Clicked row with index " + index + " of the second detail table");
- }
- }
- </script>
-
- <radG:RadGrid ID="RadGrid1" runat="server" >
- <MasterTableView Name="MasterTableView">
- <DetailTables>
- <radG:GridTableView Name="DetailTableView1" >
- </radG:GridTableView>
- <radG:GridTableView Name="DetailTableView2">
- </radG:GridTableView>
- </DetailTables>
- </MasterTableView>
- <ClientSettings>
- <ClientEvents OnRowDblClick="OnRowDblClick"></ClientEvents>
- </ClientSettings>
- </radG:RadGrid>
-
-
-
-
- Gets or sets a value indicating if the will be
- shown in the current GridTableView.
-
-
- true, if the GridHeaderItem will be shown in
- the current GridTableView; otherwise, false. The
- default value is true.
-
- ShowFooter Property
-
-
-
- Gets or sets a value indicating if the will be
- shown in the current GridTableView.
-
-
- true, if the GridGroupFooterItem will be shown in
- the current GridTableView; otherwise, false. The
- default value is true.
-
- ShowFooter Property
-
-
-
- Gets or sets a value indicating if the will be
- shown in the current GridTableView.
-
-
- true, if the GridFooterItem will be shown in
- the current GridTableView; otherwise, false. The
- default value is false.
-
- ShowHeader Property
-
-
-
- Gets an array of all columns that are used when rendering the grid
- instance.
-
- An array of all columns that are used when rendering the grid instance.
-
- Modifying the array would not affect rendering as it is regenerated before
- each data-bind. To modify the list of columns available use
- property.
-
- Columns Property
-
-
-
-
- Gets a collection of all data items of a grid table view and items that belong
- to child tables of the GridTableView if the hierarchy is
- expanded. The items are collected depth-first. The property
- actually referres to
- ItemsHierarchy of
- . This property can be used to
- traverse all
- DataItems items in the hiearchy of a GridTableView.
-
-
-
- A GridDataItemCollection of all data items of a grid table view
- and items that belong to child tables of the GridTableView if the
- hierarchy is expanded.
-
- GridDataItem Class
-
-
-
- Gets a collection of GridDataItem objects that represent the data items in a
- GridDataItem
- control.
-
-
- The Items property (collection) is used to store the data items
- in a GridTableView control. The GridTableView control
- automatically populates the Items collection by creating a
- GridDataItem object for each record in the data source and then adding
- each object to the collection. This property is commonly used to access a specific item
- in the control or to iterate though the entire collection of items.
-
-
- A GridDataItemCollection that contains all the data items in a
- GridTableView control
-
- GridDataItem Class
-
-
- AllowCustomPaging Property
-
-
-
-
- Gets or sets a value indicating the index of the currently active page in case
- paging is enabled ( is
- true).
-
- The index of the currently active page in case paging is enabled.
- AllowCustomPaging Property
- AllowPaging Property
-
-
-
- If set to true (the default)
- GridNoRecordsItem
- is used to display no records template. This item is the only one displayed in the
- GridTableView in this case.
-
- NoRecordsTemplate Property
-
-
-
- Gets a value indicating if the GridTableView instance has
- children (Detail) tables.
-
-
- true, if the GridTableView instance has
- children (Detail) tables; otherwise, false.
-
- DetailTables Property
-
-
-
- Gets or sets the programmatic identifier assigned to the current
- GridTableView.
-
-
- This property is set automatically by RadGrid object that
- owns this instance.
-
- The programmatic identifier assigned to the control.
-
- Only combinations of alphanumeric characters and the underscore character ( _ )
- are valid values for this property. Including spaces or other invalid characters will
- cause an ASP.NET page parser error.
-
- OwnerID Property
-
-
-
- Gets or sets a value indicating whether RadGrid will be built on
- PreRender unless it was built before that. This property is supposed for
- Telerik RadGrid internal usage, yet you can set it with care.
-
-
- true, if the RadGrid will be built on
- PreRender; otherwise, false.
-
-
-
-
- The unique hierarchy index of the current table view, generated when it is
- binding.
-
- The hierarchy index of the current table view.
-
-
-
- Indicates whether the items have been created, generally by data-binding.
-
-
- true, if the items have beed created; otherwise,
- false.
-
-
-
-
- This property is used internally by RadGrid and it is not
- intended to be used directly from your code.
-
-
-
-
-
-
- Gets or sets the custom content for the pager item in a
- GridTableView
- control.
-
-
- A
- System.Web.UI.ITemplate
- that contains the custom content for the pager item. The default value is null, which
- indicates that this property is not set.
-
-
- If this template is set, RadGrid will not create the default
- pager controls.
-
- AllowPaging Property
- PagingManager Property
-
-
-
- Gets or sets the template that will be instantiated in the CommandItem. If
- this template is set, RadGrid will not create the default
- CommandItem controls.
-
-
- A
- System.Web.UI.ITemplate
- object that contains the custom content for the pager item. The default value is null,
- which indicates that this property is not set.
-
- GridCommandItem Class
- CommandItemSettings Property
-
-
-
- Gets or sets a value indicating if the GridTableView is
- currently in insert mode.
-
-
- true, if the GridTableView is currently in
- insert mode; otherwise, false.
-
-
- The ItemInserted property indicates if the GridTableView is
- currently in insert mode. After setting it you should call the
- method. You can also use the
- method, that will also reposition the grid to show
- the last page, where the newly inserted item is generally displayed.
-
-
-
-
- Gets or sets a value indicating if the GridTableView should override the
- default DataSourceControl sorting with grid native sorting.
-
-
- You can set this to true in case of ObjectDataSource with IEnumerable data without implemented sorting.
-
-
-
-
- Gets or sets the default position of the GridCommandItem as defined by the
- . The possible values are:
-
- None - this is the default value - the command item will not be rendered
- Top - the command item will be rendered on the top of the grid
- Bottom - the command item will be rendered on the bottom of the grid
- TopAndBottom - the command item will be rendered both on top and bottom of the
- grid.
-
-
- A
- GridCommandItemDisplay
- proprty which define the default position of the
- GridCommandItem.
-
- GridCommandItemDisplay Enumeration
-
-
-
- Stores a custom PageSize value if such is set when page mode is NextPrevAndNumeric
-
-
-
-
- corresponding fields from a master-detail relation
-
-
-
-
-
- A collection that stores objects.
-
-
-
-
-
-
-
- Initializes a new instance of .
-
-
-
-
-
-
- Initializes a new instance of based on another .
-
-
-
- A from which the contents are copied
-
-
-
-
-
- Initializes a new instance of containing any array of objects.
-
-
-
- A array of objects with which to intialize the collection
-
-
-
-
- Adds a with the specified value to the
- .
-
- The to add.
-
- The index at which the new element was inserted.
-
-
-
-
-
- Copies the elements of an array to the end of the .
-
-
- An array of type containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
-
- Adds the contents of another to the end of the collection.
-
-
-
- A containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
- Gets a value indicating whether the
- contains the specified .
-
- The to locate.
-
- if the is contained in the collection;
- otherwise, .
-
-
-
-
-
- Copies the values to a one-dimensional instance at the
- specified index.
-
- The one-dimensional that is the destination of the values copied from .
- The index in where copying begins.
-
- None.
-
- is multidimensional.-or-The number of elements in the is greater than the available space between and the end of .
- is .
- is less than 's lowbound.
-
-
-
-
- Returns the index of a in
- the .
-
- The to locate.
-
- The index of the of in the
- , if found; otherwise, -1.
-
-
-
-
-
- Inserts a into the at the specified index.
-
- The zero-based index where should be inserted.
- The to insert.
- None.
-
-
-
-
- Returns an enumerator that can iterate through
- the .
-
- None.
-
-
-
-
- Removes a specific from the
- .
-
- The to remove from the .
- None.
- is not found in the Collection.
-
-
-
- Represents the entry at the specified index of the .
-
- The zero-based index of the entry to locate in the collection.
-
- The entry at the specified index of the collection.
-
- is outside the valid range of indexes for the collection.
-
-
-
- Container of misc. grouping settings of RadGrid control
-
-
-
-
- Expression similar to SQL's "Select Group By" clause that is used by
- GridTableView to group items
- (. Expressions can be defined by
- assigning Expression property and/or managing the
- items in or
- collections.
-
-
- If you use property to assign
- group by expression as string then the expression is parsed and
- and
- are created. If the
- expression syntax is incorrect a would be
- thrown. You can use 's properties to set
- expression's fields appearance format strings, etc. See
- property for details about the expression syntax.
-
-
-
- Constructs a new GroupByExpression from a grid GridColumn.
-
- If the column does not have a valid string assigned this
- constructor will throw . Column should be
- The following properties will be copied from the corresponding column's properties:
-
-
- Column's data-format-string depending on the type of the column. For example
- will be copied to
- .
-
- Column's will be copied to
-
-
-
-
- the column (and its DataField respectively) that will be used
- for grouping Telerik RadGrid
-
-
-
- Calls GridGroupByExpression(expression)
-
-
- The same as the property
- the string representation of the expression.
-
-
-
- Compares the current expression against the expression set as parameter and check
- if both expressions contain field with the same name.
-
-
- true if both expressions contain field with the same name,
- otherwise false.
-
- expression to check against this expression
-
-
- Checks if the given expression contains same Group-By field as this one.
-
- true if the expression already contains this GroupByField, otherwise
- false.
-
-
- Use this function to determine if two expressions seem to produce the same set of results
-
- Expression to check
-
-
-
- Gets a collection of SelectField objects (field names, aggregates etc.) that form
- the "Select" clause. Standing on the left side of the "Group By" clause.
-
-
-
-
- Gets a collection of objects that form the grouping
- clause. Standing on the right side of the "Group By" clause
-
-
-
- String representation of the GroupBy expression.
-
- Expression syntax:
- fieldname[ alias]|aggregate(fieldname)[ alias][, ...] Group By fieldname[
- sort][, ...]
-
-
- fieldname: the name of any field from the
-
-
- alias: alas string. This cannot contain blanks or other
- reserved symbols like ',', '.' etc.
-
- aggregate: any of - min, max,
- sum, count, last, first etc (the same
- as in enumeration )
-
- sort: asc or desc - the sort order of
- the grouped items
-
-
-
-
- Country, City, count(Country) Items, ContactName Group By Country, City desc
-
-
- Country, City, count(Country) Items, ContactName Group By Country, City desc
-
-
-
-
-
- Gets the index of the expression if added in a
-
-
-
- integer, representing the index of the collection ni
- .
-
-
-
-
- Collection that stores group by expressions
-
-
-
-
-
- Initializes a new instance of .
-
-
-
-
-
-
- Initializes a new instance of based on another .
-
-
-
- A from which the contents are copied
-
-
-
-
-
- Initializes a new instance of containing any array of objects.
-
-
-
- An array of objects with which to intialize the collection
-
-
-
-
- Adds a with the specified value to the
- .
-
- The to add.
-
- The index at which the new element was inserted.
-
-
-
-
-
- Parses value and adds a to the
- .
-
- The string representation to add.
-
- The index at which the new element was inserted.
-
-
-
-
-
- Copies the elements of an array to the end of the .
-
-
- An array of type containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
-
- Adds the contents of another to the end of the collection.
-
-
-
- A containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
- Gets a value indicating whether the
- contains the specified .
-
- The to locate.
-
- if the is contained in the collection;
- otherwise, .
-
-
-
-
-
- Copies the values to a one-dimensional instance at the
- specified index.
-
- The one-dimensional that is the destination of the values copied from .
- The index in where copying begins.
-
- None.
-
- is multidimensional.-or-The number of elements in the is greater than the available space between and the end of .
- is .
- is less than "s lowbound.
-
-
-
-
- Returns the index of a in
- the .
-
- The to locate.
-
- The index of the of in the
- , if found; otherwise, -1.
-
-
-
-
-
- Inserts a into the at the specified index.
-
- The zero-based index where should be inserted.
- The to insert.
- None.
-
-
-
-
- Returns an enumerator that can iterate through
- the .
-
- None.
-
-
-
-
- Removes a specific from the
- .
-
- The to remove from the .
- None.
- is not found in the Collection.
-
-
-
- Represents the entry at the specified index of the .
-
- The zero-based index of the entry to locate in the collection.
-
- The entry at the specified index of the collection.
-
- is outside the valid range of indexes for the collection.
-
-
-
- GridGroupPanel appears on the top of Telerik RadGrid
- when ShowGroupPanel of RadGrid is set to
- true and if
- is set to true, you can drag column to the panel to group data by
- that column.
-
- Basic Grouping
- Traversing items in group panel
-
-
- protected void RadGrid1_PreRender(object sender, System.EventArgs e)
- {
- TableCell cell;
-
- foreach (cell in RadGrid1.GroupPanel.GroupPanelItems)
- {
- Control ctrl;
- foreach (ctrl in cell.Controls)
- {
- if (ctrl is ImageButton)
- {
- ImageButton button = ctrl as ImageButton;
- button.ImageUrl = "<my_img_url>";
- button.CausesValidation = false;
- }
- }
- }
- }
-
-
- Protected Sub RadGrid1_PreRender(ByVal sender As Object, ByVal e As System.EventArgs) Handles RadGrid1.PreRender
- Dim cell As TableCell
-
- For Each cell In RadGrid1.GroupPanel.GroupPanelItems
- Dim ctrl As Control
- For Each ctrl In cell.Controls
- If (Typeof ctrl Is ImageButton) Then
- Dim button As ImageButton = CType(ctrl, ImageButton)
- button.ImageUrl = "<my_img_url>"
- button.CausesValidation = False
- End If
- Next ctrl
- Next cell
- End Sub
-
-
-
- Group by fields (displayed in the GroupPanel) are defined through the
- GridGroupByExpressions.
-
-
-
- For internal usage only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets a collection of items displayed in the group panel. These items represent
- the GroupByFields used for Telerik RadGrid
- grouping.
-
-
-
- protected void RadGrid1_PreRender(object sender, System.EventArgs e)
- {
- TableCell cell;
-
- foreach (cell in RadGrid1.GroupPanel.GroupPanelItems)
- {
- Control ctrl;
- foreach (ctrl in cell.Controls)
- {
- if (ctrl is ImageButton)
- {
- ImageButton button = ctrl as ImageButton;
- button.ImageUrl = "<my_img_url>";
- button.CausesValidation = false;
- }
- }
- }
- }
-
-
- Protected Sub RadGrid1_PreRender(ByVal sender As Object, ByVal e As System.EventArgs) Handles RadGrid1.PreRender
- Dim cell As TableCell
-
- For Each cell In RadGrid1.GroupPanel.GroupPanelItems
- Dim ctrl As Control
- For Each ctrl In cell.Controls
- If (Typeof ctrl Is ImageButton) Then
- Dim button As ImageButton = CType(ctrl, ImageButton)
- button.ImageUrl = "<my_img_url>"
- button.CausesValidation = False
- End If
- Next ctrl
- Next cell
- End Sub
-
-
- Traversing items in group panel
-
-
-
- Gets or sets the text displayed in the group panel to urge the user dragging a
- column to group by.
-
-
-
- <GroupPanel Text="Drag here the column you need to group by."></GroupPanel>
-
-
-
- Note that the GroupPanel Text has a default value, so you don't need to set it
- generally.
-
-
-
- Gets the style that will be used for the group panel.
-
-
-
-
-
- Gets or sets a value indicating whether the group panel will be displayed.
- true, if group panel is visible, otherwise false (the default value).
-
-
-
-
-
- Summary description for GridGroupPanelStyle.
-
-
-
- A navigation control used to create context menus.
-
-
- The RadContextMenu control is used to display context-aware options for various targets. Those targets
- are specified through the property. RadContextMenu supports the following targets:
-
-
-
- - Used to associate a context menu with an ASP.NET Server control.
- Accepts the control ID as an argument.
-
-
- - Used to associate a context menu with an HTML element. Accepts
- the HTML element id as an argument.
-
-
- - Used to specify document-wide context menu.
-
-
- - Used to associate a context menu with all elements with the specified
- tag name (e.g. IMG, INPUT).
-
-
-
-
-
- A navigation control used to display a menu in a web page.
-
-
- The RadMenu control is used to display a list of menu items in a Web Forms
- page. The RadMenu control supports the following features:
-
-
-
- Databinding that allows the control to be populated from various
- datasources.
-
-
- Programmatic access to the RadMenu object model
- which allows dynamic creation of menus, populating with items and customizing the behavior
- by various properties.
-
-
- Customizable appearance through built-in or user-defined skins.
-
-
-
Items
-
- The RadMenu control is made up of tree of items represented
- by objects. Items at the top level (level 0) are
- called root items. An item that has a parent item is called a child item. All root
- items are stored in the property of the RadMenu control. Child items are
- stored in the Items property of their parent .
-
-
- Each menu item has a Text and a Value property.
- The value of the Text property is displayed in the RadMenu control,
- while the Value property is used to store any additional data about the item,
- such as data passed to the postback event associated with the item. When clicked, an item can
- navigate to another Web page indicated by the NavigateUrl property.
-
-
-
-
-
-
-
-
-
- Defines properties that menu item containers (RadMenu,
- RadMenuItem) should implement
-
-
-
- Gets the parent IRadMenuItemContainer.
-
-
- Gets the collection of child items.
-
- A RadMenuItemCollection that represents the child
- items.
-
-
- Use this property to retrieve the child items. You can also use it to
- programmatically add or remove items.
-
-
-
-
- Populates the RadMenu control from external XML file.
-
-
- The newly added items will be appended after any existing ones.
-
-
- The following example demonstrates how to populate RadMenu control
- from XML file.
-
- private void Page_Load(object sender, EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- RadMenu1.LoadContentFile("~/Menu/Examples/Menu.xml");
- }
- }
-
-
- Private Sub Page_Load(sender As Object, e As EventArgs) Handles MyBase.Load
- If Not Page.IsPostBack Then
- RadMenu1.LoadContentFile("~/Menu/Examples/Menu.xml")
- End If
- End Sub
-
-
- The name of the XML file.
-
-
-
- Gets a linear list of all items in the RadMenu
- control.
-
-
- An IList<RadMenuItem> containing all items (from all hierarchy
- levels).
-
-
- Use the GetAllItems method to obtain a linear collection of all
- items regardless their place in the hierarchy.
-
-
- The following example demonstrates how to disable all items within a
- RadMenu control.
-
- void Page_Load(object sender, EventArgs e)
- {
- foreach (RadMenuItem item in RadMenu1.GetAllItems())
- {
- item.Enabled = false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- For Each childItem As RadMenuItem In RadMenu1.GetAllItems
- childItem.Enabled = False
- Next
- End Sub
-
-
-
-
-
- Searches the RadMenu control for the first
- RadMenuItem with a Text property equal to
- the specified value.
-
-
- A RadMenuItem whose Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the RadMenu control for the first
- RadMenuItem with a Text property equal to
- the specified value.
-
-
- A RadMenuItem whose Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadMenu control for the first
- RadMenuItem with a Value property equal
- to the specified value.
-
-
- A RadMenuItem whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the RadMenu control for the first
- RadMenuItem with a Value property equal
- to the specified value.
-
-
- A RadMenuItem whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadMenu control for the first
- Item with a NavigateUrl
- property equal to the specified value.
-
-
- A Item whose NavigateUrl
- property is equal to the specified value.
-
-
- The method returns the first Item matching the search criteria. If no Item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Returns the first RadMenuItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadMenu1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadMenuItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadMenu1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadMenuItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- This methods clears the selected item of the current RadMenu instance.
- Useful when you need to clear item selection after postback.
-
-
-
-
- Gets a list of all client-side changes (adding an item, removing an item, changing an item's property) which have occurred.
-
-
- A list of objects which represent all client-side changes the user has performed.
- By default the ClientChanges property returns empty list. Client-changes are recorded if and only if the client-side
- methods trackChanges()/commitChanges() have been invoked.
-
-
- You can use the ClientChanges property to respond to client-side modifications such as
-
- adding a new item
- removing existing item
- clearing the children of an item or the control itself
- changing a property of the item
-
- The ClientChanges property is available in the first postback (ajax) request after the client-side modifications
- have taken place. After this moment the property will return empty list.
-
-
- The following example demonstrates how to use the ClientChanges property
-
- foreach (ClientOperation<RadMenuItem> operation in RadToolBar1.ClientChanges)
- {
- RadMenuItem item = operation.Item;
-
- switch (operation.Type)
- {
- case ClientOperationType.Insert:
- //An item has been inserted - operation.Item contains the inserted item
- break;
- case ClientOperationType.Remove:
- //An item has been inserted - operation.Item contains the removed item.
- //Keep in mind the item has been removed from the menu.
- break;
- case ClientOperationType.Update:
- UpdateClientOperation<RadMenuItem> update = operation as UpdateClientOperation<RadMenuItem>
- //The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- break;
- case ClientOperationType.Clear:
- //All children of have been removed - operation.Item contains the parent item whose children have been removed. If operation.Item is null then the root items have been removed.
- break;
- }
- }
-
-
- For Each operation As ClientOperation(Of RadMenuItem) In RadToolBar1.ClientChanges
- Dim item As RadMenuItem = operation.Item
- Select Case operation.Type
- Case ClientOperationType.Insert
- 'An item has been inserted - operation.Item contains the inserted item
- Exit Select
- Case ClientOperationType.Remove
- 'An item has been inserted - operation.Item contains the removed item.
- 'Keep in mind the item has been removed from the menu.
- Exit Select
- Case ClientOperationType.Update
- Dim update As UpdateClientOperation(Of RadMenuItem) = TryCast(operation, UpdateClientOperation(Of RadMenuItem))
- 'The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- Exit Select
- Case ClientOperationType.Clear
- 'All children of have been removed - operation.Item contains the parent item whose children have been removed. If operation.Item is Nothing then the root items have been removed.
- Exist Select
- End Select
- Next
-
-
-
-
-
- Gets a object that contains the root items of the current RadMenu control.
-
-
- A that contains the root items of the current RadMenu control. By default
- the collection is empty (RadMenu has no children).
-
-
- Use the Items property to access the root items of the RadMenu control. You can also use the Items property to
- manage the root items - you can add, remove or modify items.
-
-
- The following example demonstrates how to programmatically modify the properties of a root item.
-
- RadMenu1.Items[0].Text = "Example";
- RadMenu1.Items[0].NavigateUrl = "http://www.example.com";
-
-
- RadMenu1.Items(0).Text = "Example"
- RadMenu1.Items(0).NavigateUrl = "http://www.example.com"
-
-
-
-
-
- Gets or sets the template for displaying the items in
- RadMenu.
-
-
-
- An object which implements the ITemplate interface.
- The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
- The ItemTemplate property sets a template that will be used
- for all menu items.
-
- To specify unique display for individual items use the
- ItemTemplate property of the
- RadMenuItem class.
-
-
-
- The following example demonstrates how to use the
- ItemTemplate property to add a CheckBox for each item.
- ASPX:
- <telerik:RadMenu runat="server" ID="RadMenu1">
-
- </telerik:RadMenu>
-
-
-
-
- Gets or sets the template displayed when child items are being loaded.
-
-
- The following example demonstrates how to use the LoadingStatusTemplate to display an image.
-
- <telerik:RadMenu runat="server" ID="RadMenu1">
- <LoadingStatusTemplate>
- <asp:Image runat="server" ID="Image1" ImageUrl="~/Img/loading.gif" />
- </LoadingStatusTemplate>
- </telerik:RadMenu>
-
-
-
-
- Gets the settings for the animation played when an item opens.
-
- An AnnimationSettings that represents the
- expand animation.
-
-
-
- Use the ExpandAnimation property to customize the expand
- animation of RadMenu. You can specify the
- Type and
- the Duration of the expand animation.
- To disable expand animation effects you should set the
- Type to
- AnimationType.None.
- To customize the collapse animation you can use the
- CollapseAnimation property.
-
-
-
- The following example demonstrates how to set the ExpandAnimation
- of RadMenu.
-
- ASPX:
-
-
- <telerik:RadMenu ID="RadMenu1" runat="server">
- <ExpandAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadMenuItem Text="News" >
- <Items>
- <telerik:RadMenuItem Text="CNN" NavigateUrl="http://www.cnn.com"
- />
- <telerik:RadMenuItem Text="Google News" NavigateUrl="http://news.google.com"
- />
- </Items>
- </telerik:RadMenuItem>
- <telerik:RadMenuItem Text="Sport" >
- <Items>
- <telerik:RadMenuItem Text="ESPN" NavigateUrl="http://www.espn.com"
- />
- <telerik:RadMenuItem Text="Eurosport" NavigateUrl="http://www.eurosport.com"
- />
- </Items>
- </telerik:RadMenuItem>
- </Items>
-
-
- </telerik:RadMenu>
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadMenu1.ExpandAnimation.Type = AnimationType.Linear;
- RadMenu1.ExpandAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadMenu1.ExpandAnimation.Type = AnimationType.Linear
- RadMenu1.ExpandAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the timeout after which a menu item starts to
- open.
-
-
- An integer specifying the timeout measured in milliseconds. The default value is
- 100 milliseconds.
-
-
- Use the ExpandDelay property to delay item opening.
-
- To customize the timeout prior to item closing use the
- CollapseDelay property.
-
-
-
- The following example demonstrates how to specify a half second (500
- milliseconds) timeout prior to item opening:
- ASPX:
- <telerik:RadMenu ID="RadMenu1" runat="server"
- ExpandDelay="500" />
-
-
-
- Gets the settings for the animation played when an item closes.
-
- An AnnimationSettings that represents the
- collapse animation.
-
-
-
- Use the CollapseAnimation property to customize the expand
- animation of RadMenu. You can specify the
- Type,
- Duration and the
- items are collapsed.
- To disable expand animation effects you should set the
- Type to
- AnimationType.None. To customize the expand animation you can
- use the ExpandAnimation property.
-
-
-
- The following example demonstrates how to set the
- CollapseAnimation of RadMenu.
-
- ASPX:
-
-
- <telerik:RadMenu ID="RadMenu1" runat="server">
- <CollapseAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadMenuItem Text="News" >
- <Items>
- <telerik:RadMenuItem Text="CNN" NavigateUrl="http://www.cnn.com"
- />
- <telerik:RadMenuItem Text="Google News" NavigateUrl="http://news.google.com"
- />
- </Items>
- </telerik:RadMenuItem>
- <telerik:RadMenuItem Text="Sport" >
- <Items>
- <telerik:RadMenuItem Text="ESPN" NavigateUrl="http://www.espn.com"
- />
- <telerik:RadMenuItem Text="Eurosport" NavigateUrl="http://www.eurosport.com"
- />
- </Items>
- </telerik:RadMenuItem>
- </Items>
-
-
- </telerik:RadMenu>
-
-
-
-
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadMenu1.CollapseAnimation.Type = AnimationType.Linear;
- RadMenu1.CollapseAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadMenu1.CollapseAnimation.Type = AnimationType.Linear
- RadMenu1.CollapseAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the timeout after which a menu item starts to
- close.
-
-
- An integer specifying the timeout measured in milliseconds. The default value is
- 500 (half a second).
-
-
- Use the CollapseDelay property to delay item closing. To
- cause immediate item closing set this property to 0 (zero).
-
- To customize the timeout prior to item closing use the
- ExpandDelay property.
-
-
-
- The following example demonstrates how to specify one second (1000
- milliseconds) timeout prior to item closing:
- ASPX:
- <telerik:RadMenu ID="RadMenu1" runat="server"
- ClosingDelay="1000" />
-
-
-
- Gets or sets a value indicating the way top level items will flow.
-
- One of the ItemFlow values. The default value for top
- level items is Horizontal.
-
-
- Use the Flow property to customize the way top level items are
- displayed. If set to Horizontal items are positioned one after
- another. Vertical causes the items to flow one below the other.
-
-
- The following example demonstrates how to make a vertical menu.
- ASPX:
- <telerik:RadMenu ID="RadMenu1" runat="server"
- Flow="Vertical" />
-
-
-
- Specifies the default settings for child item behavior.
-
- An instance of the MenuItemGroupSettings
- class.
-
-
- You can customize the following settings
-
- item flow
- expand direction
- horizontal offset from the parent item
- vertical offset from the parent item
- width
- height
-
-
- For more information check
- MenuItemGroupSettings.
-
-
-
-
-
- Gets or sets a value indicating if an automatic scroll is applied if the groups are larger then the screen height.
-
-
-
-
- Gets or sets a value indicating if scroll is enabled for the root items.
- Width must be set for horizontal root group, Height for vertical one.
-
-
-
-
- Gets or sets a value indicating if the currently selected item will be tracked and highlighted.
-
-
-
-
- The minimum available height that is needed to enable the auto-scroll.
-
-
- Enabling the auto-scroll when there is very little available space can
- lead to a situation where only the scroll arrows are visible.
-
- If the available space is lower than the specified value, the menu will
- attempt to screen boundary detection first (if enabled).
-
-
-
-
- The minimum available width that is needed to enable the auto-scroll.
-
-
- The minimum width measured in pixels. The default value is 50 pixels.
-
-
-
- Enabling the auto-scroll when there is very little available space can
- lead to a situation where only the scroll arrows are visible.
-
-
- If the available space is lower than the specified value, the menu will
- attempt to screen boundary detection first (if enabled).
-
-
-
-
-
- Gets or sets a value indicating whether the screen boundary detection will be applied when menu items are expanded.
-
-
- By default RadMenu will check if there is enough space to open a menu item. If there isn't the expand direction of the
- item will be inverted - Left to Right, Bottom to Top and vice versa.
-
-
-
-
- Gets or sets a value indicating whether root items should open on mouse
- click.
-
-
- True if the root items open on mouse click; otherwise
- false. The default value is false.
-
-
- Use the ClickToOpen property to customize the way root menu
- items are opened. By default menu items are opened on mouse hovering.
-
-
-
-
- Gets the settings for the web service used to populate items
- ExpandMode set to
- MenuItemExpandMode.WebService.
-
-
- An WebServiceSettings that represents the
- web service used for populating items.
-
-
-
- Use the WebServiceSettings property to configure the web
- service used to populate items on demand.
- You must specify both Path and
- Method
- to fully describe the service.
-
-
- You can use the LoadingStatusTemplate
- property to create a loading template.
-
-
- In order to use the integrated support, the web service should have the following signature:
-
-
- [ScriptService]
- public class WebServiceName : WebService
- {
- [WebMethod]
- public RadMenuItemData[] WebServiceMethodName(RadMenuItemData item, object context)
- {
- // We cannot use a dictionary as a parameter, because it is only supported by script services.
- // The context object should be cast to a dictionary at runtime.
- IDictionary<string, object> contextDictionary = (IDictionary<string, object>) context;
-
- //...
- }
- }
-
-
-
-
-
-
- When set to true, the items populated through Load On Demand are persisted on the server.
-
-
-
-
- Gets or sets a value indicating if an overlay should be rendered (only in Internet Explorer).
-
-
- The overlay is an iframe element that is used to hide select and other elements from overlapping the menu.
-
-
-
-
- Gets a collection of objects that define the relationship
- between a data item and the menu item it is binding to.
-
-
- A that represents the relationship between a data item and the menu item it is binding to.
-
-
-
-
- Gets or sets the maximum number of levels to bind to the RadMenu control.
-
-
- The maximum number of levels to bind to the RadMenu control. The default is -1,
- which binds all the levels in the data source to the control.
-
-
- When binding the RadMenu control to a data source, use the MaxDataBindDepth
- property to limit the number of levels to bind to the control. For example, setting this property to 2 binds only
- the root menu items and their immediate children. All remaining records in the data source are ignored.
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when a menu item is clicked.
-
-
- The URL of the Web page to post to from the current page when a menu item is clicked.
- The default value is an empty string (""), which causes the page to post back to itself.
-
-
-
-
- Gets a RadMenuItem object that represents the selected item in the RadMenu
- control.
-
-
- The user can select a item by clicking on it.
- Use the SelectedItem property to determine which node is
- selected in the RadMenu control.
-
- An item cannot be selected when it's configured to navigate to a given location.
-
-
-
-
- Gets the Value of the selected item.
-
-
- The Value of the selected item.
- If there is no selected item returns empty string.
-
-
-
-
- Occurs on the server when an item in the RadMenu control is
- created.
-
-
- The ItemCreated event is raised every time a new item is
- added.
- The ItemCreated event is not related to data binding and you
- cannot retrieve the DataItem of the item in the event
- handler.
- The ItemCreated event is often useful in scenarios where you want
- to initialize all items - for example setting the ToolTip of each
- RadMenuItem to be equal to the Text property.
-
-
- The following example demonstrates how to use the ItemCreated
- event to set the ToolTip property of each item.
-
- private void RadMenu1_ItemCreated(object sender, Telerik.WebControls.RadMenuItemEventArgs e)
- {
- e.Item.ToolTip = e.Item.Text;
- }
-
-
- Sub RadMenu1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.WebControls.RadMenuItemEventArgs) Handles RadMenu1.ItemCreated
- e.Item.ToolTip = e.Item.Text
- End Sub
-
-
-
-
-
- Occurs on the server when a menu item in the RadMenu
- control is clicked.
-
-
-
- The menu will also postback if you navigate to a menu item
- using the [menu item] key and then press [enter] on the menu item that is focused. The
- instance of the clicked menu item is passed to the MenuItemClick event
- handler - you can obtain a reference to it using the eventArgs.RadMenuItem property.
-
-
-
-
- Occurs after a menu item is data bound.
-
-
- The ItemDataBound event is raised for each menu item upon
- databinding. You can retrieve the item being bound using the event arguments.
- The DataItem associated with the item can be retrieved using
- the DataItem property.
-
- The ItemDataBound event is often used in scenarios when
- you want to perform additional mapping of fields from the DataItem
- to their respective properties in the RadMenuItem class.
-
-
- The following example demonstrates how to map fields from the data item to
- item properties using the ItemDataBound
- event.
-
- private void RadMenu1_ItemDataBound(object sender, Telerik.WebControls.RadMenuEventArgs e)
- {
- RadMenuItem item = e.RadMenuItem;
- DataRowView dataRow = (DataRowView) e.Item.DataItem;
-
- item.ImageUrl = "image" + dataRow["ID"].ToString() + ".gif";
- item.NavigateUrl = dataRow["URL"].ToString();
- }
-
-
- Sub RadMenu1_ItemDataBound(ByVal sender As Object, ByVal e As RadMenuEventArgs) Handles RadMenu1.ItemDataBound
- Dim item As RadMenuItem = e.RadMenuItem
- Dim dataRow As DataRowView = CType(e.Item.DataItem, DataRowView)
-
- item.ImageUrl = "image" + dataRow("ID").ToString() + ".gif"
- item.NavigateUrl = dataRow("URL").ToString()
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse moves over a menu item in the RadMenu control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientMouseOver
- client-side event handler is called when the mouse moves over a
- menu item. Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with two properties, get_item() (the
- instance of the menu item) and get_domEvent (a reference to the browser event).
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientMouseOver property.
-
-
-
-
-
-
-
- If specified, the OnClientMouseOut client-side event handler
- is called when the mouse moves out of a menu item. Two parameters are passed to the
- handler:
-
- sender, the menu client object;
- eventArgs with two properties, get_item() (the
- instance of the menu item) and get_domEvent (a reference to the browser event).
-
- This event cannot be cancelled.
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse moves out of a menu item in the RadMenu control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientMouseOutHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat= "server"
- OnClientMouseOut="onClientMouseOutHandler">
- ....
- </telerik:RadMenu>
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a menu item gets focus.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientItemFocusHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemFocus="onClientItemFocusHandler">
- ....
- </telerik:RadMenu>
-
-
- If specified, the OnClientItemFocus client-side event
- handler is called when a menu item is selected using either the keyboard (the [TAB]
- or arrow keys) or by clicking it. Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with two properties, get_item() (the
- instance of the menu item) and get_domEvent (a reference to the browser event).
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after an item loses focus.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientItemBlur client-side event handler
- is called when a menu item loses focus as a result of the user pressing a key or
- clicking elsewhere on the page. Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with two properties, get_item() (the
- instance of the menu item) and get_domEvent (a reference to the browser event).
-
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function onClientItemBlurHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemBlur="onClientItemBlurHandler">
- ....
- </telerik:RadMenu>
-
-
-
-
- This event is similar to OnClientItemFocus but fires only on
- mouse click.
- If specified, the OnClientItemClicking client-side event
- handler is called before a menu item is clicked upon. Two parameters are passed to
- the handler:
-
- sender, the menu client object;
- eventArgs with three properties, get_item() (the
- instance of the menu item), get_cancel()/set_cancel() - indicating
- if the event should be cancelled and get_domEvent (a reference to the browser event).
-
- The OnClientItemClicking event can be cancelled. To do so,
- return False from the event handler.
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a menu item is clicked.
-
-
- <script type="text/javascript">
- function onClientItemClickingHandler(sender, eventArgs)
- {
- if (eventArgs.get_item().get_text() == "News")
- {
- return false;
- }
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemClicking="onClientItemClickingHandler">
- ....
- </telerik:RadMenu>
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after a menu item is clicked.
-
-
- This event is similar to OnClientItemFocus but fires only on
- mouse click.
- If specified, the OnClientItemClicked client-side event
- handler is called after a menu item is clicked upon. Two parameters are passed to
- the handler:
-
- sender, the menu client object;
- eventArgs with two properties, get_item() (the
- instance of the menu item) and get_domEvent (a reference to the browser event).
-
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function onClientItemClickedHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemClicked="onClientItemClickedHandler">
- ....
- </telerik:RadMenu>
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a group of child items begin to open.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientItemOpening client-side event handler
- is called when a group of child items opens. Two parameters are passed to the
- handler:
-
- sender, the menu client object;
- eventArgs with three properties, get_item() (the
- instance of the menu item), get_cancel()/set_cancel() - indicating
- if the event should be cancelled and get_domEvent (a reference to the browser event).
-
- This event can be cancelled by calling eventArgs.set_cancel(true).
-
-
- <script type="text/javascript">
- function onClientItemOpeningHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemOpening="onClientItemOpeningHandler">
- ....
- </telerik:RadMenu>
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a group of child items opens.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientItemOpened client-side event handler
- is called when a group of child items opens. Two parameters are passed to the
- handler:
-
- sender, the menu client object;
- eventArgs with two properties, get_item() (the
- instance of the menu item) and get_domEvent (a reference to the browser event).
-
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function onClientItemOpenedHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemOpen="onClientItemOpenedHandler">
- ....
- </telerik:RadMenu>
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a group of child items is closing.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientItemClosingHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemClose="onClientItemClosingHandler">
- ....
- </telerik:RadMenu>
-
-
- If specified, the OnClientItemClosing client-side event
- handler is called when a group of child items closes. Two parameters are passed to
- the handler:
-
- sender, the menu client object;
- eventArgs with three properties, get_item() (the
- instance of the menu item), get_cancel()/set_cancel() - indicating
- if the event should be cancelled and get_domEvent (a reference to the browser event).
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a group of child items closes.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientItemClosedHandler(sender, eventArgs)
- {
- alert(eventArgs.get_item().get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemClose="onClientItemClosedHandler">
- ....
- </telerik:RadMenu>
-
-
- If specified, the OnClientItemClosed client-side event
- handler is called when a group of child items closes. Two parameters are passed to
- the handler:
-
- sender, the menu client object;
- eventArgs with two properties, get_item() (the
- instance of the menu item) and get_domEvent (a reference to the browser event).
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a menu item children are about to be populated (for example from web service).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientItemPopulatingHandler(sender, eventArgs)
- {
- var item = eventArgs.get_item();
- var context = eventArgs.get_context();
- context["CategoryID"] = item.get_value();
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemPopulating="onClientItemPopulatingHandler">
- ....
- </telerik:RadMenu>
-
-
- If specified, the OnClientItemPopulating client-side event
- handler is called when a menu item children are about to be populated.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with three properties:
-
- get_item(), the instance of the menu item.
- get_context(), an user object that will be passed to the web service.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a menu item children were just populated (for example from web service).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientItemPopulatedHandler(sender, eventArgs)
- {
- var item = eventArgs.get_item();
- alert("Loading finished for " + item.get_text());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemPopulated="onClientItemPopulatedHandler">
- ....
- </telerik:RadMenu>
-
-
- If specified, the OnClientItemPopulated client-side event
- handler is called when a menu item children were just populated.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with one property:
-
- get_item(), the instance of the menu item.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the operation for populating the children of a menu item has failed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientItemPopulationFailedHandler(sender, eventArgs)
- {
- var item = eventArgs.get_item();
- var errorMessage = eventArgs.get_errorMessage();
-
- alert("Error: " + errorMessage);
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat="server"
- OnClientItemPopulationFailed="onClientItemPopulationFailedHandler">
- ....
- </telerik:RadMenu>
-
-
- If specified, the OnClientItemPopulationFailed client-side event
- handler is called when the operation to populate the children of a menu item has failed.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with two properties:
-
- get_item(), the instance of the menu item.
- set_cancel(), set to true to suppress the default action (alert message).
-
-
-
- This event can be cancelled.
-
-
-
-
- If specified, the OnClienLoad client-side event handler is
- called after the menu is fully initialized on the client.
- A single parameter - the menu client object - is passed to the
- handler.
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function onClientLoadHandler(sender)
- {
- alert(sender.get_id());
- }
- </script>
- <telerik:RadMenu ID="RadMenu1"
- runat= "server"
- OnClientLoad="onClientLoadHandler">
- ....
- </telerik:RadMenu>
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after the RadMenu client-side object is initialized.
-
-
-
-
- Will be serialized to the client, so it can render
- the UL element with of the root group with the appropriate class.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets the collection containing the targets to which right-click
- RadContextMenu will attach.
-
- A ContextMenuTargetCollection
- containing the targets to which RadContextMenu will attach.
-
- RadContextMenu can attach to four target types: ASP.NET control, element on the page,
- document, set of client-side elements, specified by tagName.
-
-
- This example demonstrates how to specify that the RadContextMenu will be displayed
- when a specific textbox and all images on the page clicked.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadContextMenu is to be displayed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientShowing client-side event handler is
- called before the context menu is shown on the client. Two parameters are passed to the
- handler:
-
- sender, the menu client object;
- eventArgs with two properties,
- get_cancel()/set_cancel(cancel) and
- get_domEvent (a reference to the browser event).
-
- The OnClientShowing event can be cancelled. To do so,
- set the cancel property to false from the event handler (e.g.
- eventArgs.set_cancel(true);).
-
-
- The following example demonstrates how to use the
- OnClientShowing property.
-
-
- <script type="text/javascript">
- var shouldDisplayContextMenu = confirm("Do you want to enable context menus on this page?");
- function onClientShowingHandler(sender, eventArgs)
- {
- eventArgs.set_cancel(!shouldDisplayContextMenu);
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadContextMenu is displayed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientShown client-side event handler is
- called after the context menu is shown on the client. Two parameters are passed to the
- handler:
-
- sender, the menu client object;
- eventArgs with one property, get_domEvent
- (a reference to the browser event).
-
-
-
- The following example demonstrates how to use the
- OnClientShown property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadContextMenu is to be hidden.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientHiding client-side event handler is
- called before the context menu is hidden on the client. Two parameters are passed to the
- handler:
-
- sender, the menu client object;
- eventArgs with two properties,
- get_cancel()/set_cancel(cancel) and
- get_domEvent (a reference to the browser event).
-
- The OnClientHiding event can be cancelled. To do so,
- set the cancel property to false from the event handler (e.g.
- eventArgs.set_cancel(true);).
-
-
- The following example demonstrates how to use the
- OnClientHiding property.
-
-
- <script type="text/javascript">
- function onClientShowingHandler(sender, eventArgs)
- {
- var shouldHide = confirm("Do you want to hide the context menu?")
- eventArgs.set_cancel(!shouldHide);
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadContextMenu is hidden.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientHidden client-side event handler is
- called after the context menu is hidden on the client. Two parameters are passed to the
- handler:
-
- sender, the menu client object;
- eventArgs with one property, get_domEvent
- (a reference to the browser event).
-
-
-
- The following example demonstrates how to use the
- OnClientHidden property.
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets a value indicating if the currently selected item will be tracked and highlighted.
-
-
-
-
-
-
-
-
- Represents the filtering menu for Telerik RadGrid.
-
-
-
- Summary description for NeedDataSourceEvent.
-
-
-
-
- RadGrid control class.
-
-
-
- Set properties of RadGrid as default for the corresponding properties of grid's
- table views .
- The best approach to bind RadGrid is to handle its event and set the DataSource property
- there. This way RadGrid will handle automatically operations like paging, sorting, grouping, etc.
- The main table-view can be accessed through property.
- The group panel and its items can be accessed using GroupPanel property. Note that the group items can be modified only
- through the properties of each GridTableView.
- Hierarchical grid structure can be implemented adding GridTableView objects to and handling
- event, where you should set the DataSource of each bound detail table filtered
- according to the property key values.
- The of RadGrid property is a reference to the columns of the MasterTableView and is present in RadGrid for
- compatibility with the DataGrid server control.
-
-
-
- Represents the Cancel command name. This field is read-only.
-
- Use the CancelCommandName field to represent the "Cancel" command name.
- This command cancels the edit operation and RadGrid returns to normal mode.
-
-
- The example below demonstrates how to use the Cancel command within an
- EditItemTemplate.
-
-
-
-
- Represents the "Delete" command name. This field is read-only.
-
- Use the DeleteCommandName field to represent the "Delete" command
- name.
-
-
- The example below demonstrates how to use the Delete command within an
- ItemTemplate.
-
-
-
-
- Represents the "Edit" command name. This field is read-only.
-
- Use the EditCommandName field to represent the "Edit" command name. This
- command enters RadGrid in edit mode.
-
-
- The example below demonstrates how to use the "Edit" command within an
- ItemTemplate.
-
-
-
-
- Represents the "InitInsert" command name. This field is read-only.
-
- The example below demonstrates how to use the InitInsert command within an
- CommandItemTemplate.
-
- <CommandItemTemplate>
-
-
- <asp:LinkButton runat="server" ID="AddNew" Text="Add new record" CommandName="InitInsert">
-
-
- </asp:LinkButton>
-
-
- </CommandItemTemplate>
-
-
-
- Use the InitInsertCommandName field to represent the
- "InitInsert" command name. This command enters RadGrid in edit mode and lets the user
- enter the data for a new record.
-
-
-
- Represents the "PerformInsert" command name. This field is read-only.
-
- Use the PerformInsertCommandName field to represent the
- "PerformInsert" command name. This command enters the new record into the
- database.
-
-
-
-
- Represents the "RebindGrid" command name. This field is read-only. Forces
- RadGrid.Rebind
-
-
- Use the RebindGridCommandName field to force rebinding the
- grid.
-
-
-
-
- The example below demonstrates how to use the Update command within an
- EditItemTemplate.
-
-
- Represents the "Update" command name. This field is read-only.
-
- Use the UpdateCommandName field to represent the "Update" command
- name.
-
-
-
-
- Represents the "UpdateEdited" command name. Updates all items that are in edit
- mode. This field is read-only.
-
-
- The example below demonstrates how to use the UpdateEdited command within an
- CommandItemTemplate.
-
-
-
- Use the UpdateCommandName field to represent the "Update" command
- name.
-
-
-
- Represents the "DeleteSelected" command name. This field is read-only.
-
- Use the DeleteSelectedCommandName field to represent the
- "DeleteSelected" command name.
-
-
- The example below demonstrates how to use the DeleteSelected command within
- an CommandItemTemplate.
-
-
-
-
- Represents the "DownloadAttachment" command name. This field is read-only.
-
- Use the DownloadAttachment field to represent the
- "DownloadAttachment" command name.
-
-
-
-
- Constructs a new instance of RadGrid
-
-
-
-
- Data-bind %MasterTableView% and its detail
- %GridTableView%s. Prior to calling DataBind, the
- %DataSource% property should be assigned.
-
- Simple Data-binding
-
- You should have in mind, that in case you are using simple data binding (i.e.
- when you are not using NeedDataSource event) the correct approach
- is to call the DataBind() method on the first page load when
- !Page.IsPostBack and after handling some event (sort event for
- example).
- You will need to assign DataSource and rebind the grid after
- each operation (paging, sorting, editing, etc.) - this copies exactly MS
- DataGrid behavior.
-
- We recommend using the method instead and handling
- the event.
-
-
-
-
-
-
-
-
-
- This method is used by RadGrid internally. Please do not use.
-
-
-
-
- Forces RadGrid to fire
- NeedDataSource
- event then calls
- DataBind
-
-
-
-
-
-
-
-
-
- Occurs when the Cancel button is clicked for an item in the
- Telerik RadGrid control.
-
-
- The CancelCommand event is raised when the Cancel button is clicked for an
- item in the Telerik RadGrid control.
-
-
-
- The following code example demonstrates how to specify and code a handler for the
- CancelCommand event to cancel edits made to an item in the
- Telerik RadGrid control.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Protected Sub RadGrid1_CancelCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs)
- Response.Write("Cancel")
- End Sub
-
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnCancelCommand="RadGrid1_CancelCommand" >
- <MasterTableView>
- <Columns>
- <radG:GridEditCommandColumn>
- </radG:GridEditCommandColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Fires when each editable column creates its column editor, prior to initializing its controls in the cells of the grid
-
-
-
-
- Fires when the grid is about to be bound and the data source must be assigned
- (is null/Nothing).
-
-
-
- Using this event eliminates the need for calling
- when the grid content should be refreshed, due to a structural change.
- For example if Edit command bubbles, grid will automatically rebind and display
- the item in edit mode, with no additional code.
-
- Note that when you use NeedDataSource you need to assign
- manually the DataSource property only once in the event handler!
- Important: You should never call Rebind()
- method in NeedDataSource event handler or
- DataBind() for the grid
- at any stage of the page lifecycle!
- For more information related to Advanced Data Binding (i.e. with
- NeedDataSource) see the following Data
- binding article.
-
-
-
-
- Fires when various item events occur - for example, before Pager item is
- initialized, before EditForm is initialized, etc.
-
-
-
-
- Fires when a detail-table in the hierarchy is about to be bound. You should only assign the DataSource property of the detail table to a
- data-source properly filtered to display ony child records related to the parent item.
-
-
- You can find the instance of the detail table in the event argument (e). You can
- find the parent item using e.DetailTable.ParentItem property. For more information see
- Hierarchical Binding
-
-
-
-
- Occurs when the Delete button is clicked for an item in the
- Telerik RadGrid control.
-
-
- The DeleteCommand event is raised when the Delete button is clicked for an
- item in the Telerik RadGrid control.
- A typical handler for the DeleteCommand event removes the selected item from
- the data source.
-
-
- The following code example demonstrates how to specify and code a handler for the
- CancelCommand event to cancel a Telerik RadGrid control.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Protected Sub RadGrid1_DeleteCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs)
- Response.Write("Delete")
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnDeleteCommand="RadGrid1_DeleteCommand" >
- <MasterTableView>
- <Columns>
- <radG:GridButtonColumn Text="Delete" CommandName="Delete" UniqueName="Delete"></radG:GridButtonColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Occurs when the Edit button is clicked for an item in the
- Telerik RadGrid control.
-
-
- The EditCommand event is raised when the Edit button is clicked for an item
- in the Telerik RadGrid control.
- A typical handler for the EditCommand event edites the selected item from the
- data source.
-
-
- The following code example demonstrates how to specify and code a handler for the
- EditCommand event to edit a Telerik RadGrid control.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Protected Sub RadGrid1_EditCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs)
- Response.Write("Edit")
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnEditCommand="RadGrid1_EditCommand" >
- <MasterTableView>
- <Columns>
- <radG:GridEditCommandColumn>
- </radG:GridEditCommandColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Occurs when a button is clicked in a Telerik RadGrid
- control.
-
-
- The ItemCommand event is raised when a button is clicked in the
- Telerik RadGrid control. This allows you to provide an event-handling
- method that performs a custom routine whenever this event occurs.
- Buttons within a Telerik RadGrid control can also invoke some of
- the built-in functionality of the control. Fires if any control inside
- Telerik RadGrid rises a bubble event. This can be a command button
- (like Edit, Update button, Expand/Collapse of an items) The command arguemtn
- carries a reference to the item which rised the event, the command name and
- argument object.
- A GridCommandEventArgs object is passed to the event-handling method, which
- allows you to determine the command name and command argument of the button
- clicked.
-
-
- The following code example demonstrates how to use the ItemCommand event to add the
- name of a customer from a Telerik RadGrid control to a ListBox control when a item's Add
- button is clicked.
-
- <%@ Page Language="VB" <see cref="> <"/>@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
-
- Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.Web.UI.GridItemEventArgs)
- If e.Item.ItemType = GridItemType.AlternatingItem Or e.Item.ItemType = GridItemType.Item Then
- Dim item As Telerik.Web.UI.GridDataItem
- item = e.Item
- Dim LinkButton1 As LinkButton
- LinkButton1 = item("LinkColumn").FindControl("LinkButton1")
- LinkButton1.CommandArgument = e.Item.ItemIndex.ToString()
- End If
- End Sub
-
- Protected Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs)
- ' If multiple buttons are used in a Telerik RadGrid control, use the
- ' CommandName property to determine which button was clicked.
- If e.CommandName = "Add" Then
-
- ' Convert the row index stored in the CommandArgument
- ' property to an Integer.
- Dim index As Integer = Convert.ToInt32(e.CommandArgument)
-
- ' Retrieve the item that contains the button clicked
- ' by the user from the Items collection.
- Dim item As Telerik.Web.UI.GridDataItem = RadGrid1.Items(index)
-
- ' Create a new ListItem object for the customer in the item.
- Dim nitem As New ListItem()
- nitem.Text = Server.HtmlDecode(item("CustomerID").Text)
-
- ' If the customer is not already in the ListBox, add the ListItem
- ' object to the Items collection of the ListBox control.
- If Not CustomersListBox.Items.Contains(nitem) Then
-
- CustomersListBox.Items.Add(nitem)
-
- End If
-
- End If
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnItemCreated="RadGrid1_ItemCreated" OnItemCommand="RadGrid1_ItemCommand">
- <MasterTableView>
- <Columns>
- <radG:GridTemplateColumn
- UniqueName="LinkColumn"
- HeaderText="LinkColumn">
- <ItemTemplate>
- <asp:LinkButton CommandName="Add" Text="click" ID="LinkButton1" runat="server">LinkButton</asp:LinkButton>
- </ItemTemplate>
- </radG:GridTemplateColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <asp:listbox id="CustomersListBox" runat="server"/>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Occurs when an item is created in a Telerik RadGrid
- control.
-
-
- Before the Telerik RadGrid control can be rendered, a GridItem
- object must be created for each row in the control. The ItemCreated event is raised
- when each row in the Telerik RadGrid control is created. This allows
- you to provide an event-handling method that performs a custom routine, such as
- adding custom content to a item, whenever this event occurs.
- A GridItemEventArgs object is passed to the event-handling method, which
- allows you to access the properties of the row being created. You can determine
- which item type (header item, data pager item, and so on) is being bound by using
- the Item.ItemType property.
- Note that the changes made to the item control and its
- children at this stage does not persist into the ViewState.
-
-
- The following code example demonstrates how to use the ItemCreated event to store
- the index of the item being created in the CommandArgument property of a LinkButton
- control contained in the item. This allows you to determine the index of the item
- that contains the LinkButton control when the user clicked the button.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
-
- Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.Web.UI.GridItemEventArgs)
- If e.Item.ItemType = GridItemType.AlternatingItem Or e.Item.ItemType = GridItemType.Item Then
- Dim item As Telerik.Web.UI.GridDataItem
- item = e.Item
- Dim LinkButton1 As LinkButton
- LinkButton1 = item("LinkColumn").FindControl("LinkButton1")
- LinkButton1.CommandArgument = e.Item.ItemIndex.ToString()
- End If
- End Sub
-
- Protected Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs)
- ' If multiple buttons are used in a Telerik RadGrid control, use the
- ' CommandName property to determine which button was clicked.
- If e.CommandName = "Add" Then
-
- ' Convert the row index stored in the CommandArgument
- ' property to an Integer.
- Dim index As Integer = Convert.ToInt32(e.CommandArgument)
-
- ' Retrieve the item that contains the button clicked
- ' by the user from the Items collection.
- Dim item As Telerik.Web.UI.GridDataItem = RadGrid1.Items(index)
-
- ' Create a new ListItem object for the customer in the item.
- Dim nitem As New ListItem()
- nitem.Text = Server.HtmlDecode(item("CustomerID").Text)
-
- ' If the customer is not already in the ListBox, add the ListItem
- ' object to the Items collection of the ListBox control.
- If Not CustomersListBox.Items.Contains(nitem) Then
-
- CustomersListBox.Items.Add(nitem)
-
- End If
-
- End If
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnItemCreated="RadGrid1_ItemCreated" OnItemCommand="RadGrid1_ItemCommand">
- <MasterTableView>
- <Columns>
- <radG:GridTemplateColumn
- UniqueName="LinkColumn"
- HeaderText="LinkColumn">
- <ItemTemplate>
- <asp:LinkButton CommandName="Add" Text="click" ID="LinkButton1" runat="server">LinkButton</asp:LinkButton>
- </ItemTemplate>
- </radG:GridTemplateColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <asp:listbox id="CustomersListBox" runat="server"/>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Fires before a custom column is created. You can handle the
- event to replace or modify the instance of the column that should be created and added
- into the collection of column in the corresponding
- GridTableView.
-
-
- The ColumnCreating event of Telerik RadGrid is
- fired only for custom grid columns. It is not designed to be used
- to cancel the creation of auto-generated columns. Its purpose is to have place
- where to define your custom columns (extending the default grid columns)
- programmatically and add them to the grid Columns
- collection.
- See the manual part of Telerik RadGrid documentation for details
- about Telerik RadGrid inheritance.
-
-
-
-
- The ColumnCreated event of Telerik RadGrid is
- designated to customize auto-generated columns at runtime (for example
- DataFormatString, ReadOnly or other properties of
- these auto-generated columns).
-
-
- This event is fired after the creation of auto-generated
- columns.
-
-
-
-
- Occurs when a data item is bound to data in a Telerik RadGrid
- control.
-
-
- Before the Telerik RadGrid control can be rendered, each item in
- the control must be bound to a record in the data source. The ItemDataBound event
- is raised when a data item (represented by a GridItem object) is bound to data in
- the Telerik RadGrid control. This allows you to provide an
- event-handling method that performs a custom routine, such as modifying the values
- of the data bound to the item, whenever this event occurs.
- A GridItemEventArgs object is passed to the event-handling method, which
- allows you to access the properties of the item being bound. You can determine
- which item type (header item, data pager item, and so on) is being bound by using
- the Item.ItemType property.
- Note that the changes made to the item control and its children does persist
- into the ViewState. This event is fired as a result of a data-binding of Telerik RadGrid
- contorl. This event is fired for items of type:
-
- GridDataItem
- GridEditFormItem
- GridHeaderItem
- GridPagerItem
- GridFooterItem
-
-
-
- The following code example demonstrates how to use the ItemDataBound event to
- modify the value of a field in the data source before it is displayed in a
- Telerik RadGrid control.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Protected Sub RadGrid1_ItemDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.GridItemEventArgs)
- If e.Item.ItemType = GridItemType.AlternatingItem Or e.Item.ItemType = GridItemType.Item Then
- Dim item As Telerik.Web.UI.GridDataItem
- item = e.Item
- item("CustomerID").Text = "Telerik"
- End If
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnItemDataBound="RadGrid1_ItemDataBound">
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </form>
- </body>
- </html>
-
-
-
-
- Fires when a paging action has been performed.
-
-
-
- Fires when
- PageSize property
- value has been changed.
-
-
- The PageSizeChanged event is rised when the value of the property
- PageSize is changed. You can cancel the event if the new PageSize value is
- invalid and it will not be saved. For example:
-
-
-
-
- Occurs when a column is sorted.
-
- The SortCommand event is raised when a column is sorted.
- A typical handler for the SortCommand event sorts the list.
-
-
- The following code example demonstrates how to specify and code a handler for the
- SortCommand event to sort a Telerik RadGrid control.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Protected Sub RadGrid1_SortCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridSortCommandEventArgs)
- Response.Write("Sort")
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1" AllowSorting="true"
- runat="server" OnSortCommand="RadGrid1_SortCommand" >
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Occurs when the Update button is clicked for an item in the
- Telerik RadGrid control.
-
-
- The UpdateCommand event is raised when the Update button is clicked for an
- item in the Telerik RadGrid control.
- A typical handler for the UpdateCommand event updates the selected item from
- the data source.
-
-
- The following code example demonstrates how to specify and code a handler for the
- UpdateCommand event to update a Telerik RadGrid control.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Protected Sub RadGrid1_UpdateCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs)
- Response.Write("Update")
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnUpdateCommand="RadGrid1_UpdateCommand" >
- <MasterTableView>
- <Columns>
- <radG:GridEditCommandColumn>
- </radG:GridEditCommandColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Occurs when the Insert button is clicked for an item in the
- Telerik RadGrid control.
-
-
- The InsertCommand event is raised when the Insert button is clicked for an
- item in the Telerik RadGrid control.
- A typical handler for the InsertCommand event insert the item into the data
- source.
-
-
- The following code example demonstrates how to specify and code a handler for the
- InsertCommand event to insert a Telerik RadGrid control.
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
-
- Protected Sub RadGrid1_InsertCommand(ByVal source As Object, ByVal e As Telerik.Web.UI.GridCommandEventArgs)
- Response.Write("Insert")
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server" OnInsertCommand="RadGrid1_InsertCommand" >
- <MasterTableView CommandItemDisplay="TopAndBottom">
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Fires when a grouping action has been performed. For example when a column header
- was dragged in the GroupPanel.
-
-
- You can use this event to set your own
- GridGroupByExpression
- when the user tries to group the grid.
-
-
-
- protected void RadGrid1_GroupsChanging(object source, Telerik.Web.UI.GridGroupsChangingEventArgs e)
- {
- //Expression is added (by drag/grop on group panel)
-
- if (e.Action == GridGroupsChangingAction.Group)
- {
- if (e.Expression.GroupByFields[0].FieldName != "CustomerID")
- {
- GridGroupByField countryGroupField = new GridGroupByField();
- countryGroupField.FieldName = "Country";
- GridGroupByField cityGroupField = new GridGroupByField();
- cityGroupField.FieldName = "City";
-
- e.Expression.SelectFields.Clear();
- e.Expression.SelectFields.Add(countryGroupField);
- e.Expression.SelectFields.Add(cityGroupField);
-
- e.Expression.GroupByFields.Clear();
- e.Expression.GroupByFields.Add(countryGroupField);
- e.Expression.GroupByFields.Add(cityGroupField);
- }
-
- }
- }
-
-
- Protected Sub RadGrid1_GroupsChanging(ByVal source As Object, ByVal e As Telerik.Web.UI.GridGroupsChangingEventArgs)
- 'Expression is added (by drag/grop on group panel)
- If (e.Action = GridGroupsChangingAction.Group) Then
- If (e.Expression.GroupByFields(0).FieldName <> "CustomerID") Then
- Dim countryGroupField As GridGroupByField = New GridGroupByField
- countryGroupField.FieldName = "Country"
- Dim cityGroupField As GridGroupByField = New GridGroupByField
- cityGroupField.FieldName = "City"
- e.Expression.SelectFields.Clear
- e.Expression.SelectFields.Add(countryGroupField)
- e.Expression.SelectFields.Add(cityGroupField)
- e.Expression.GroupByFields.Clear
- e.Expression.GroupByFields.Add(countryGroupField)
- e.Expression.GroupByFields.Add(cityGroupField)
- End If
- End If
- End Sub
-
-
-
-
- Fires when a grid item has been updated.
-
-
- Fires when a grid item has been inserted.
-
-
- Fires when a grid item has been deleted.
-
-
- Fires when a grid is exported to excelML and styles collections is created.
-
-
- Fires when a grid is exported to excelML and row is created.
-
-
- Fires when a grid is exporting.
-
-
- Fires when a grid is exporting.
-
-
-
-
-
-
-
- Fires when a columns reorder action has been performed.
-
-
-
- Gets or sets the object from which the Telerik RadGrid control
- retrieves its list of data items.
-
-
- You should have in mind, that in case you are using simple data binding (i.e.
- when you are not using NeedDataSource event) the correct approach
- is to call the DataBind() method on the first page load when
- !Page.IsPostBack and after handling some event (sort event for
- example).
- You will need to assign DataSource and rebind the grid after
- each operation (paging, sorting, editing, etc.) - this copies exactly MS
- DataGrid behavior.
-
-
- An object that represents the data source from which the
- Telerik RadGrid control retrieves its data. The default is a null reference
- (Nothing in Visual Basic).
-
-
- The following code example demonstrates how the DataSource property of a
- Telerik RadGrid control is used. In this example, the
- Telerik RadGrid control is bound to a DataSet object. After the DataSource
- property is set, the DataBind method is called explicitly.
-
-
-
-
- Gets or sets the name of the list of data that the Telerik RadGrid
- control binds to, in cases where the data source contains more than one distinct list
- of data items.
-
-
- The name of the specific list of data that the Telerik RadGrid
- control binds to, if more than one list is supplied by a data source control. The
- default value is String.Empty.
-
-
-
- Use the DataMember property to specify a member from a multimember data
- source to bind to the list control. For example, if you have a data source with
- more than one table specified in the DataSource
- property, use the DataMember property to specify which table to bind to
- a data listing control.
-
- The value of the DataMember property is stored in view state.
- This property cannot be set by themes or style sheet themes. For more
- information, see ThemeableAttribute and Themes and Skins
- Overview in MSDN.
-
-
-
-
-
- Gets a reference to the object that
- allows you to set the properties of the grouping operation in a
- Telerik RadGrid control.
-
-
-
- The following code example demonstrates how to set the GroupingSettings property
- declaratively. It sets the tooltips of the group expand control of the
- Telerik RadGrid.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server">
- <GroupingSettings ExpandTooltip="ExpandTooltip" />
- <MasterTableView>
- <GroupByExpressions>
- <radG:GridGroupByExpression>
- <SelectFields>
- <radG:GridGroupByField FieldAlias="CompanyName" FieldName="CompanyName" ></radG:GridGroupByField>
- </SelectFields>
- <GroupByFields>
- <radG:GridGroupByField FieldName="CompanyName" SortOrder="Descending"></radG:GridGroupByField>
- </GroupByFields>
- </radG:GridGroupByExpression>
- </GroupByExpressions>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
- A reference to the that allows you to set
- the properties of the grouping operation in a Telerik RadGrid control.
-
-
- Use the GroupingSettings property to control the settings of
- the grouping operations in a Telerik RadGrid control. This property is
- read-only; however, you can set the properties of the
- GridGroupingSettings object it returns. The properties can be set
- declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridGroupingSettings object (for example,
- GroupingSettings-ExpandTooltip).
- Nest a <GroupingSettings> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, GroupingSettings.ExpandTooltip). Common settings
- usually include the tool tips for the sorting controls.
-
-
-
-
-
- Gets a reference to the object that
- allows you to set the properties of the sorting operation in a
- Telerik RadGrid control.
-
-
-
- A reference to the that allows you to set
- the properties of the sorting operation in a Telerik RadGrid control.
-
-
- Use the SortingSettings property to control the settings of the sorting
- operations in a Telerik RadGrid control. This property is read-only;
- however, you can set the properties of the GridSortingSettings object it returns.
- The properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridSortingSettings object (for example,
- SortingSettings-SortedAscToolTip).
- Nest a <SortingSettings> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, SortingSettings.SortedAscToolTip). Common
- settings usually include the tool tips for the sorting controls.
-
-
- The following code example demonstrates how to set the SortingSettings property
- declaratively. It sets the tooltips of the sorting control of the
- Telerik RadGrid control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- AllowSorting="true">
- <SortingSettings SortToolTip="SortToolTip" SortedAscToolTip="SortedAscToolTip" SortedDescToolTip="SortedDescToolTip" />
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
-
- Gets a reference to the object that
- allows you to set the properties of the hierarchical
- Telerik RadGrid control.
-
-
-
- A reference to the GridHierarchySettings that allows you to set the properties of
- the hierarchical Telerik RadGrid control.
-
-
- Use the HierarchySettings property to control the settings of the
- hierarchical Telerik RadGrid control. This property is read-only;
- however, you can set the properties of the GridHierarchySettings object it returns.
- The properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridHierarchySettings object (for example,
- HierarchySettings-CollapseTooltip).
- Nest a <HierarchySettings> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, HierarchySettings.CollapseTooltip). Common
- settings usually include the tool tips for the hierarchical
- Telerik RadGrid control.
-
-
-
-
-
-
-
-
-
- Gets a reference to the object that
- allows you to set the properties of the grouping operation in a
- Telerik RadGrid control.
-
-
-
- A reference to the GridExportSettings that allows you to set the properties of
- the grouping operation in a Telerik RadGrid control.
-
-
- Use the ExportSettings property to control the settings of the grouping
- operations in a Telerik RadGrid control. This property is read-only;
- however, you can set the properties of the GridGroupingSettings object it returns.
- The properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridExportSettings object (for example,
- GroupingSettings-ExpandTooltip).
- Nest a <GroupingSettings> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, GroupingSettings.ExpandTooltip). Common settings
- usually include the tool tips for the sorting controls.
-
-
-
-
-
- Gets a reference to the object that
- allows you to set the properties of the validate operation in a
- Telerik RadGrid control.
-
-
-
- A reference to the that allows you to set
- the properties of the validate operation in a Telerik RadGrid control.
-
-
- The following code example demonstrates how to set the
- ValidationSettings property declaratively. It sets the validation
- for the PerformInsert command event of the TextBox1 control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- AutoGenerateColumns="false"
- runat="server">
- <ValidationSettings
- EnableValidation="true"
- CommandsToValidate="PefrormInsert" />
- <MasterTableView CommandItemDisplay="TopAndBottom">
- <Columns>
- <radG:GridEditCommandColumn>
- </radG:GridEditCommandColumn>
- <radG:GridTemplateColumn HeaderText="ContactName" UniqueName="ContactName" DataField="ContactName">
- <ItemTemplate>
- <%# Eval("ContactName") <see cref="TextBox Text='<">>
- </ItemTemplate>
- <EditItemTemplate>
- <asp</see># Bind("ContactName") %>' ID="TextBox1" runat="server"></asp:TextBox>
- <asp:RequiredFieldValidator ControlToValidate="TextBox1" ID="RequiredFieldValidator1" runat="server" ErrorMessage="RequiredFieldValidator"></asp:RequiredFieldValidator>
- </EditItemTemplate>
- </radG:GridTemplateColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>"
- SelectCommand="SELECT TOP 3 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
- Use the ValidationSettings property to control the settings of the validate
- operations in a Telerik RadGrid control. This property is read-only;
- however, you can set the properties of the GridValidationSettings object it
- returns. The properties can be set declaratively using one of the following
- methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridValidationSettings object (for example,
- ValidationSettings-EnableValidation).
- Nest a <ValidationSettings> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, ValidationSettings.EnableValidation). Common
- settings usually include the propeties for the validation logic in
- Telerik RadGrid control.
-
-
-
-
-
-
-
-
- Gets or sets a value indicating whether custom paging should be performed instead
- of the integrated automatic paging.
-
-
-
-
- This online example demonstrates an approach to implementing custom paging with
- Telerik RadGrid. The simulated "DataLayer" wraps the logic of extracting records
- for only the specified page and deleting records. Telerik RadGrid
- maintains the pager buttons, changing of pager and other presentation specific
- features.
- Another available option for custom paging support is represented in the
- how-to
- section.
- Note: There is no universal mechanism for grouping when
- custom paging is allowed. The reason for this is that with the custom paging
- mechanism you fetch only part of the whole information from the grid datasource.
- Thus, when you trigger the grouping event the grid is restricted from operating
- with the whole available source data and is not able to group the items accurately.
- Furthermore, the aggregate functions as Count, Sum, etc. (covering operations with
- the whole set of grid items) will return incorrect results.
- A workaround solution for you could be to use hierarchy in the grid instead
- of grouping to single out the grid items logically and visually according to custom
- criteria. Thus you will be able to use custom paging without further
- limitations.
- Another approach is to build your own complex SQL statements which to get the
- whole available data from the grid datasource and then group the items in the grid
- with custom code logic.
-
- Finally, you can use standard paging instead of custom paging to ensure the
- consistency of the data on grouping.
-
-
- true, if custom paging is allowed; otherwise
- false. The default is false.
-
-
-
-
- Gets or sets a value indicating whether the automatic paging feature is
- enabled.
-
-
- true if the paging feature is enabled; otherwise,
- false. The default is false
-
-
- Instead of displaying all the records in the data source at the same time,
- the Telerik RadGrid control can automatically break the records up into
- pages. If the data source supports the paging capability, the
- Telerik RadGrid control can take advantage of that and provide built-in
- paging functionality. The paging feature can be used with any data source object
- that supports the System.Collections.ICollection interface or a data source that
- supports paging capability.
- To enable the paging feature, set the AllowPaging property
- to true. By default, the Telerik RadGrid control
- displays 10 records on a page at a time. You can change the number of records
- displayed on a page by setting the PageSize property. To determine the total number
- of pages required to display the data source contents, use the PageCount property.
- You can determine the index of the currently displayed page by using the
- CurrentPageIndex property.
- When paging is enabled, an additional item called the pager item is
- automatically displayed in the Telerik RadGrid control. The pager item contains controls
- that allow the user to navigate to the other pages. You can control the settings of
- the pager item by using the PagerItemStyle property. The pager
- item can be displayed at the top, bottom, or both the top and bottom of the control
- by setting the Position property. You can also select from one of four built-in
- pager display modes by setting the Mode property.
- The Telerik RadGrid control also allows you to define a custom
- template for the pager item.
-
-
- The following code example demonstrates how to use the AllowPaging
- property to declaratively enable the paging feature in the
- Telerik RadGrid control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- AllowPaging="true" >
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
- AllowCustomPaging Property
- Basic Paging
- Pager Item
-
-
- Gets or sets a value indicating whether the sorting feature is enabled.
-
- true if the sorting feature is enabled; otherwise,
- false. The default is false.
-
-
- When a data source control that supports sorting is bound to the
- Telerik RadGrid control, the Telerik RadGrid control can
- take advantage of the data source control's capabilities and provide automatic
- sorting functionality.
- To enable sorting, set the AllowSorting property to
- true. When sorting is enabled, the heading text for each column
- field with its SortExpression property set is displayed as a link button.
- Clicking the link button for a column causes the items in the
- Telerik RadGrid control to be sorted based on the sort expression.
- Typically, the sort expression is simply the name of the field displayed in the
- column, which causes the Telerik RadGrid control to sort with respect
- to that column. To sort by multiple fields, use a sort expression that contains a
- comma-separated list of field names. You can determine the sort expression that the
- Telerik RadGrid control is applying by using the SortExpression
- property. Clicking a column's link button repeatedly toggles the sort direction
- between ascending and descending order.
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
- The following code example demonstrates how to use the AllowSorting property to
- enable sorting in a Telerik RadGrid control when automatically
- generated columns are used.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- AllowSorting="true">
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Sorting Expressions
-
-
- Gets or sets a value indicating whether native LINQ expressions will be enabled.
-
- true if the sorting LINQ expressions are enabled; otherwise,
- false. The default is true.
-
-
-
-
-
- Gets a reference to the object that
- allows you to set the properties of the client-side behavior and appearance in
- a Telerik RadGrid control.
-
-
-
- A reference to the that allows you to set the
- properties of the the client-side behavior and appearance in a
- Telerik RadGrid control.
-
-
- Use the ClientSettings property to control the settings of the client-side
- behavior and appearance in a Telerik RadGrid control. This property is
- read-only; however, you can set the properties of the GridClientSettings object it
- returns. The properties can be set declaratively using one of the following
- methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridClientSettings object (for example,
- ClientSettings-AllowDragToGroup).
- Nest a <ClientSettings> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, SortingSettings.AllowDragToGroup). Common
- settings usually include the behavior and appearance on the client-side.
-
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of alternating data items in a Telerik RadGrid control.
-
-
- A reference to the GridTableItemStyle that represents the style of alternating
- data items in a Telerik RadGrid control.
-
-
- Use the AlternatingItemStyle property to control the appearance of
- alternating data items in a Telerik RadGrid control. When this property
- is set, the data items are displayed alternating between the ItemStyle settings and
- the AlternatingItemStyle settings. This property is read-only; however, you can set
- the properties of the GridTableItemStyle object it returns. The properties can be
- set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example,
- AlternatingItemStyle-ForeColor).
- Nest an <AlternatingItemStyle> element between the opening and
- closing tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, AlternatingItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The following code example demonstrates how to use the AlternatingItemStyle
- property to declaratively define the style for alternating data items in a
- Telerik RadGrid control.
-
- <%@ Page language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html >
- <head id="Head1" runat="server">
- <title>GridView ItemStyle and AlternatingItemStyle Example</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <h3>GridView ItemStyle and AlternatingItemStyle Example</h3>
-
- <radG:RadGrid id="CustomersGridView"
- datasourceid="CustomersSource"
- autogeneratecolumns="true"
- Skin=""
- runat="server">
-
- <itemstyle backcolor="LightCyan"
- forecolor="DarkBlue"
- font-italic="true"/>
-
- <alternatingitemstyle backcolor="PaleTurquoise"
- forecolor="DarkBlue"
- font-italic="true"/>
-
- </radG:RadGrid>
-
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:sqldatasource id="CustomersSource"
- selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
- connectionstring="<<see cref="NorthWindConnectionString">$ ConnectionStrings</see>>"
- runat="server"/>
-
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of the group-header item in a Telerik RadGrid control.
-
-
- A reference to the GridTableItemStyle that represents the style of the
- group-header item in a Telerik RadGrid control.
-
-
- Use the GroupHeaderItemStyle property to control the appearance of the
- group-header item in a Telerik RadGrid control. This property is
- read-only; however, you can set the properties of the GridTableItemStyle object it
- returns. The properties can be set declaratively using one of the following
- methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example,
- GroupHeaderItemStyle-ForeColor).
- Nest a <GroupHeaderItemStyle> element between the opening and
- closing tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, GroupHeaderItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The following code example demonstrates how to use the SelectedItemStyle property
- to define a custom style for the group-header item in a Telerik RadGrid
- control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- Skin="None" >
- <GroupHeaderItemStyle BackColor="red" />
- <MasterTableView>
- <GroupByExpressions>
- <radG:GridGroupByExpression>
- <SelectFields>
- <radG:GridGroupByField FieldAlias="CompanyName" FieldName="CompanyName" ></radG:GridGroupByField>
- </SelectFields>
- <GroupByFields>
- <radG:GridGroupByField FieldName="CompanyName" SortOrder="Descending"></radG:GridGroupByField>
- </GroupByFields>
- </radG:GridGroupByExpression>
- </GroupByExpressions>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets or sets a value indicating whether bound fields are automatically created
- for each field in the data source.
-
-
- When the AutoGenerateColumns property is set to true, an
- GridBoundColumn object is automatically created for each field in
- the data source. Each field is then displayed as a column in the
- Telerik RadGrid control in the order that the fields appear in the data
- source. This option provides a convenient way to display every field in the data
- source; however, you have limited control of how an automatically generated column
- field is displayed or behaves.
- This set of columns can be accessed using the
- AutoGeneratedColumns
- collection.
-
-
-
-
- Runtime auto-generated columns will always appear after
- the user-specified columns, unless the columns are ordered
- programmatically.
-
-
-
- Instead of letting the Telerik RadGrid control automatically
- generate the column fields, you can manually define the column fields by setting
- the AutoGenerateColumns property to false and
- then creating a custom Columns collection. In addition to bound column fields, you
- can also display a button column, a check box column, a button column, a hyperlink
- column, an image column, or a column based on your own custom-defined template
- etc.
-
-
- true to automatically create bound fields for each field in the
- data source; otherwise, false. The default is
- true.
-
-
- The following code example demonstrates how to use the AutoGenerateColumns property
- to automatically create bound columns in a Telerik RadGrid control for
- each field in the data source.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- AutoGenerateColumns="true"
- AllowSorting="true">
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets or sets a value indicating whether detail tables will be automatically created from the
- dataset object to which the grid is bound.
-
-
-
-
- Gets or sets the URL to an image to display in the background of a
- Telerik RadGrid control.
-
-
- The URL of an image to display in the background of the
- Telerik RadGrid control. The default is an empty string (""), which
- indicates that this property is not set.
-
-
- Use the BackImageUrl property to specify the URL to an image
- to display in the background of a Telerik RadGrid control.
- If the specified image is smaller than the Telerik RadGrid
- control, the image is tiled to fill in the background. If the image is larger than
- the control, the image is cropped.
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets group panel control instance - visible only if grouping is enabled in grid
- (). Each 's
- Group-By-Expression is visualized in this panel.
-
-
-
- If grouping is enabled grid allows grouping by column(s) by drag-and-drop of
- columns from it's detail tables in this panel For this purpose set
- AllowDragToGroup
- property to true. You can modify panel's appearance using
- and
- .
-
-
-
-
-
-
- Gets or sets a value indicating whether the
- would be shown in Telerik RadGrid.
-
-
-
- true, when Telerik RadGrid will display the panel; otherwise
- false. The default is false.
-
-
-
- GroupPanel
- Gets or sets a value indicating whether the grouping is enabled.
-
- Most often this property is used in conjunction with
- property set to true. The
- easiest way to turn the grouping on is by using the grid's SmartTag option for
- enabling the grouping.
-
- Basic Grouping
-
- true, when the automatic grouping is enabled; otherwise
- false. The default is false.
-
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will perform
- automatic updates to the data source.
-
-
- true, when the automatic updates are allowed; otherwise
- false. The default is false.
-
-
- See Automatic Data Source
- Operations for details.
-
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will perform
- automatic insert of records to the data source.
-
-
- See Automatic Data Source
- Operations for details.
-
-
- true, when automatic insert into the database would be
- performed; otherwise false. The default is
- false.
-
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will
- automatically delete records from the specified data source.
-
-
- See Automatic Data Source
- Operations for details.
-
-
- true, when automatic delete from the database would be
- performed; otherwise false. The default is
- false.
-
-
-
-
- The instance of that represents the main
- grid-table view in RadGrid.
-
-
-
- Telerik RadGrid introduces a new approach to hierarchical data
- structures. The innovative in Telerik RadGrid is having a so called
- MasterTableView. This is the topmost table of the hierarchical
- structure. It is a with
- . The collection holds the so called
- DetailTables - tables related to the fields of the MasterTable. Each
- DetailTable can have its own GridTableViewCollection with
- other Detail Tables, thus forming the hierarchical structure.
-
-
-
-
- Note: There is only one Master Table for
- a single Telerik RadGrid. This is the topmost table. All
- inner tables are referred as a Detail Tables regardless of whether they
- have related (inner) tables or not.
-
-
-
-
-
- A reference to the topmost , i.e the
- MasterTableView.
-
- RadGrid and MasterTableView difference
-
-
-
-
-
- Gets or sets an integer value representing the current page index.
-
- Note that the Paging must be enabled ( must
- be true) in order to use this property.
-
- zero-based int representing the index of the current page.
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of the item selected for editing in a Telerik RadGrid
- control.
-
-
- A reference to the GridTableItemStyle that represents the style of the item being
- edited in a Telerik RadGrid control.
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
- Use the EditItemStyle property to control the appearance of the item being
- edited in a Telerik RadGrid control. This property is read-only;
- however, you can set the properties of the GridTableItemStyle object it returns.
- The properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example, EditItemStyle-ForeColor).
- Nest a <EditItemStyle> element between the opening and closing tags
- of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, EditItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The following code example demonstrates how to use the EditItemStyle property to
- define a custom style for the item being edited in a Telerik RadGrid
- control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- Skin="" >
- <EditItemStyle BackColor="red" />
- <MasterTableView>
- <Columns>
- <radG:GridEditCommandColumn>
- </radG:GridEditCommandColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of the footer item in a Telerik RadGrid control.
-
-
- A reference to the GridTableItemStyle that represents the style of the footer
- item in a Telerik RadGrid control.
-
-
- Use the FooterItemStyle property to control the appearance of the footer item
- in a Telerik RadGrid control. This property is read-only; however, you
- can set the properties of the GridTableItemStyle object it returns. The properties
- can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example, FooterItemStyle-ForeColor).
- Nest a <FooterItemStyle> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, FooterItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The following code example demonstrates how to use the SelectedItemStyle property
- to define a custom style for the footer item in a Telerik RadGrid
- control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- Skin=""
- ShowFooter="true" >
- <FooterStyle BackColor="red" />
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
- Gets the style properties of the heading section in the RadGrid control.
-
- A reference to the that represents the style
- of the header item in a Telerik RadGrid control.
-
-
- Use the HeaderItemStyle property to control the appearance of the header item
- in a Telerik RadGrid control. This property is read-only; however, you
- can set the properties of the GridTableItemStyle object it returns. The properties
- can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example, HeaderItemStyle-ForeColor).
- Nest a <HeaderItemStyle> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, HeaderItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The ShowHeader property must be set to true for this property to
- be visible.
-
-
- The following code example demonstrates how to use the SelectedItemStyle property
- to define a custom style for the header item in a Telerik RadGrid
- control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- Skin="" >
- <HeaderStyle BackColor="red" />
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of the filter item in a Telerik RadGrid control.
-
-
- A reference to the GridTableItemStyle that represents the style of the filter
- item in a Telerik RadGrid control.
-
-
- Use the FilterItemStyle property to control the appearance of the filter item
- in a Telerik RadGrid control. This property is read-only; however, you
- can set the properties of the GridTableItemStyle object it returns. The properties
- can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example, FilterItemStyle-ForeColor).
- Nest a <FilterItemStyle> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, FilterItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The following code example demonstrates how to use the SelectedItemStyle property
- to define a custom style for the filter item in a Telerik RadGrid
- control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- Skin=""
- AllowFilteringByColumn="true">
- <FilterItemStyle BackColor="red" />
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of the command item in a Telerik RadGrid control.
-
-
- A reference to the GridTableItemStyle that represents the style of the command
- item in a Telerik RadGrid control.
-
-
- Use the CommandItemStyle property to control the appearance of the command
- item in a Telerik RadGrid control. This property is read-only; however,
- you can set the properties of the GridTableItemStyle object it returns. The
- properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example, CommandItemStyle-ForeColor).
- Nest a <CommandItemStyle> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, CommandItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The following code example demonstrates how to use the SelectedItemStyle property
- to define a custom style for the command item in a Telerik RadGrid
- control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- Skin="">
- <CommandItemStyle BackColor="red" />
- <MasterTableView CommandItemDisplay="TopAndBottom">
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of the active item in a Telerik RadGrid control.
-
-
- A reference to the GridTableItemStyle that represents the style of the actibe
- item in a Telerik RadGrid control.
-
-
- Use the ActiveItemStyle property to control the appearance of the active item
- in a Telerik RadGrid control. This property is read-only; however, you
- can set the properties of the GridTableItemStyle object it returns. The properties
- can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example, ActiveItemStyle-ForeColor).
- Nest a <ActiveItemStyle> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, ActiveItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
- The following code example demonstrates how to use the SelectedItemStyle property
- to define a custom style for the active item in a Telerik RadGrid
- control.
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
- Gets a collection of all GridDataItems.
-
- The RadGrid control automatically populates the Items collection by creating
- a GridDataItem object for each record in the data source and then adding each
- object to the collection. This property is commonly used to access a specific item
- in the control or to iterate though the entire collection of items.
-
- You cannot use this collection to get special Items like Header, Pager, Footer,
- etc. Handle event and use the event arguments to
- get a reference to such items.
-
-
- all grid data items as
-
-
-
- Gets a reference to the GridTableItemStyle object that allows you to set the
- appearance of the data items in a RadGrid control.
-
-
- A reference to the GridTableItemStyle that represents the style of the data items
- in a Telerik RadGrid control.
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
- <%@ Page language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html >
- <head id="Head1" runat="server">
- <title>GridView ItemStyle And AlternatingItemStyle Example</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <h3>GridView ItemStyle And AlternatingItemStyle Example</h3>
-
- <radG:RadGrid id="CustomersGridView"
- datasourceid="CustomersSource"
- autogeneratecolumns="true"
- Skin=""
- runat="server">
-
- <itemstyle backcolor="LightCyan"
- forecolor="DarkBlue"
- font-italic="true"/>
-
- <alternatingitemstyle backcolor="PaleTurquoise"
- forecolor="DarkBlue"
- font-italic="true"/>
-
- </radG:RadGrid>
-
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:sqldatasource id="CustomersSource"
- selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
- connectionstring="<<see cref="NorthWindConnectionString">$ ConnectionStrings</see>>"
- runat="server"/>
-
- </form>
- </body>
- </html>
-
-
-
- Use the ItemStyle property to control the appearance of the data items in a
- Telerik RadGrid control. When the AlternatingItemStyle property is also set, the data
- items are displayed alternating between the ItemStyle settings and the
- AlternatingItemStyle settings. This property is read-only; however, you can set the
- properties of the GridTableItemStyle object it returns.
-
-
-
-
- Gets the number of pages required to display the records of the data source
- in a Telerik RadGrid control.
-
-
- When the paging feature is enabled (by setting the AllowPaging property to true),
- use the PageCount property to determine the total number of pages required to display
- the records in the data source. This value is calculated by dividing the total number
- of records in the data source by the number of records displayed in a page (as
- specified by the PageSize property) and rounding up.
-
- The number of pages in a Telerik RadGrid control.
-
- The following code example demonstrates how to use the PageCount property to
- determine the total number of pages displayed in the Telerik RadGrid
- control.
-
- <%@ Page Language="C#" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
- protected void RadGrid1_PreRender(object sender, EventArgs e)
- {
- Label1.Text = RadGrid1.PageCount.ToString();
- }
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- AllowPaging="true"
- runat="server" OnPreRender="RadGrid1_PreRender">
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- <asp:Label ID="Label1" runat="server" Text="Label"></asp:Label></div>
- </form>
- </body>
- </html>
-
-
- <%@ Page Language="VB" @ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Protected Sub RadGrid1_PreRender(ByVal sender As Object, ByVal e As System.EventArgs)
- Label1.Text = RadGrid1.PageCount.ToString()
- End Sub
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- AllowPaging="true"
- runat="server" OnPreRender="RadGrid1_PreRender" >
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- <asp:Label ID="Label1" runat="server" Text="Label"></asp:Label></div>
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets a reference to the GridPagerStyle object that allows you to
- set the appearance of the page item in a Telerik RadGrid control.
-
-
- A GridPagerStyle object that contains the style properties of
- the paging section of the RadGrid control. The default value is an
- empty GridPagerStyle object.
-
-
- Use this property to provide a custom style for the paging section of the
- RadGrid control. Common style attributes that can be adjusted
- include forecolor, backcolor, font, and content alignment within the cell.
- Providing a different style enhances the appearance of the RadGrid
- control.
- To specify a custom style for the paging section, place the
- <PagerStyle> tags between the opening and closing tags of
- the RadGrid control. You can then list the style attributes within
- the opening <PagerStyle> tag.
-
-
- The following code example demonstrates how to use the PagerStyle
- property to specify a custom style for the page selection elements of the
- RadGrid control.
-
- <%@ Page Language="VB" %>
-
- <%@ Import Namespace="System.Data" <see cref="> <"/>@ Register TagPrefix="telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
-
- <script runat="server">
-
- Function CreateDataSource() As ICollection
- Dim dt As New DataTable()
- Dim dr As DataRow
-
- dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32)))
- dt.Columns.Add(New DataColumn("StringValue", GetType(String)))
- dt.Columns.Add(New DataColumn("DateTimeValue", GetType(String)))
- dt.Columns.Add(New DataColumn("BoolValue", GetType(Boolean)))
-
- Dim i As Integer
- For i = 0 To 99
- dr = dt.NewRow()
-
- dr(0) = i
- dr(1) = "Item " & i.ToString()
- dr(2) = DateTime.Now.ToShortDateString()
- If i Mod 2 <> 0 Then
- dr(3) = True
- Else
- dr(3) = False
- End If
-
- dt.Rows.Add(dr)
- Next i
-
- Dim dv As New DataView(dt)
- Return dv
- End Function 'CreateDataSource
-
- Sub ShowStats()
- lblEnabled.Text = "AllowPaging is " & RadGrid1.AllowPaging
- lblCurrentIndex.Text = "CurrentPageIndex is " & RadGrid1.CurrentPageIndex
- lblPageCount.Text = "PageCount is " & RadGrid1.PageCount
- lblPageSize.Text = "PageSize is " & RadGrid1.PageSize
- End Sub 'ShowStats
-
-
- Protected Sub RadGrid1_NeedDataSource(ByVal source As Object, ByVal e As Telerik.Web.UI.GridNeedDataSourceEventArgs) Handles RadGrid1.NeedDataSource
- RadGrid1.DataSource = CreateDataSource()
- ShowStats()
- End Sub
-
- Protected Sub CheckBox1_CheckedChanged(ByVal sender As Object, ByVal e As System.EventArgs) Handles CheckBox1.CheckedChanged
- If CheckBox1.Checked Then
- RadGrid1.PagerStyle.Mode = GridPagerMode.NumericPages
- Else
- RadGrid1.PagerStyle.Mode = GridPagerMode.NextPrev
- End If
-
- RadGrid1.Rebind()
- End Sub
- </script>
-
- <head id="Head1" runat="server">
- <title>RadGrid Paging Example</title>
- </head>
- <body>
- <h3>
- RadGrid Paging Example</h3>
- <form id="form1" runat="server">
- <radG:RadGrid ID="RadGrid1" runat="server" AllowPaging="True">
- <PagerStyle Mode="NumericPages" HorizontalAlign="Right"></PagerStyle>
- <HeaderStyle BackColor="#aaaadd"></HeaderStyle>
- <AlternatingItemStyle BackColor="#eeeeee"></AlternatingItemStyle>
- </radG:RadGrid>
- <br />
- <asp:CheckBox ID="CheckBox1" runat="server" Text="Show numeric page navigation buttons"
- AutoPostBack="true" />
- <br />
- <table style="background-color: #eeeeee; padding: 6">
- <tr>
- <td style="display: inline">
- <asp:Label ID="lblEnabled" runat="server" /><br />
- <asp:Label ID="lblCurrentIndex" runat="server" /><br />
- <asp:Label ID="lblPageCount" runat="server" /><br />
- <asp:Label ID="lblPageSize" runat="server" /><br />
- </td>
- </tr>
- </table>
- </form>
- </body>
- </html>
-
-
- <%@ Page Language="C#" %>
-
- <%@ Import Namespace="System.Data" <see cref="> <"/>@ Register TagPrefix="telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
-
- <script runat="server">
- ICollection CreateDataSource()
- {
- DataTable dt = new DataTable();
- DataRow dr;
- dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
- dt.Columns.Add(new DataColumn("StringValue", typeof(string)));
- dt.Columns.Add(new DataColumn("DateTimeValue", typeof(string)));
- dt.Columns.Add(new DataColumn("BoolValue", typeof(bool)));
- int i;
- for (i = 0; (i <= 99); i++)
- {
- dr = dt.NewRow();
- dr[0] = i;
- dr[1] = ("Item " + i.ToString());
- dr[2] = DateTime.Now.ToShortDateString();
- if (((i % 2)
- != 0))
- {
- dr[3] = true;
- }
- else
- {
- dr[3] = false;
- }
- dt.Rows.Add(dr);
- }
- DataView dv = new DataView(dt);
- return dv;
- }
-
- // CreateDataSource
- void ShowStats()
- {
- lblEnabled.Text = ("AllowPaging is " + RadGrid1.AllowPaging);
- lblCurrentIndex.Text = ("CurrentPageIndex is " + RadGrid1.CurrentPageIndex);
- lblPageCount.Text = ("PageCount is " + RadGrid1.PageCount);
- lblPageSize.Text = ("PageSize is " + RadGrid1.PageSize);
- }
-
- // ShowStats
- protected void RadGrid1_NeedDataSource(object source, Telerik.Web.UI.GridNeedDataSourceEventArgs e)
- {
- RadGrid1.DataSource = CreateDataSource();
- ShowStats();
- }
-
- protected void CheckBox1_CheckedChanged(object sender, System.EventArgs e)
- {
- if (CheckBox1.Checked)
- {
- RadGrid1.PagerStyle.Mode = GridPagerMode.NumericPages;
- }
- else
- {
- RadGrid1.PagerStyle.Mode = GridPagerMode.NextPrev;
- }
- RadGrid1.Rebind();
- }
- </script>
-
- <head id="Head1" runat="server">
- <title>RadGrid Paging Example</title>
- </head>
- <body>
- <h3>
- RadGrid Paging Example</h3>
- <form id="form1" runat="server">
- <radG:RadGrid ID="RadGrid1" runat="server" AllowPaging="True" OnNeedDataSource="RadGrid1_NeedDataSource">
- <PagerStyle Mode="NumericPages" HorizontalAlign="Right"></PagerStyle>
- <HeaderStyle BackColor="#aaaadd"></HeaderStyle>
- <AlternatingItemStyle BackColor="#eeeeee"></AlternatingItemStyle>
- </radG:RadGrid>
- <br />
- <asp:CheckBox ID="CheckBox1" runat="server" Text="Show numeric page navigation buttons"
- AutoPostBack="true" OnCheckedChanged="CheckBox1_CheckedChanged" />
- <br />
- <table style="background-color: #eeeeee; padding: 6">
- <tr>
- <td style="display: inline">
- <asp:Label ID="lblEnabled" runat="server" /><br />
- <asp:Label ID="lblCurrentIndex" runat="server" /><br />
- <asp:Label ID="lblPageCount" runat="server" /><br />
- <asp:Label ID="lblPageSize" runat="server" /><br />
- </td>
- </tr>
- </table>
- </form>
- </body>
- </html>
-
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
-
-
- Gets or sets an integer value indicating the number of Items that a single page
- in Telerik RadGrid will contain.
-
-
- Note that the Paging must be enabled ( must
- be true) in order to use this property.
-
-
- integer, indicating the number of the Items that a single grid page would
- contain.
-
-
-
-
- Gets or sets a value indicating whether you will be able to select multiple rows
- in Telerik RadGrid. By default this property is set to
- false.
-
-
- true if you can have multiple rows selected at once. Otherwise,
- false. The default is false.
-
-
- Note: You will not be able to select the Header, Footer or Pager
- rows.
-
-
-
-
- Gets or sets a value indicating whether Telerik RadGrid will allow
- you to have multiple rows in edit mode. The default value is
- false.
-
-
- true if you can have more than one row in edit mode. Otherwise,
- false. The default value is false.
-
-
-
-
- You can see an example usage of this property in the following online example:
-
-
- http://www.telerik.com/r.a.d.controls/Grid/Examples/Hierarchy/ThreeLevel/DefaultCS.aspx
-
- private void Page_Load(object sender, EventArgs e)
- {
- if (!IsPostBack)
- {
- RadGrid1.SelectedIndexes.Add(1, 0, 1, 0, 1);
- //Index of 1, 0, 1, 0, 1 means:
- //1 - item with index 1 in the MasterTabelView
- //0 - detail table with index 0
- //1 - item with index 1 (the second item) in the first detail table
- //0 - 0 the third-level detail table
- //1 - the item with index 1 in the third-level table
- }
- }
-
-
- Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- If Not IsPostBack Then
- RadGrid1.SelectedIndexes.Add(1, 0, 1, 0, 1)
- 'Index of 1, 0, 1, 0, 1 means:
- '1 - item With index 1 In the MasterTabelView
- '0 - detail table With index 0
- '1 - item With index 1 (the second item) In the first detail table
- '0 - 0 the third-level detail table
- '1 - the item With index 1 In the third-level table
- End If
- End Sub
-
-
- Gets a collection of indexes of the selected items.
-
- returns of the indexes of all selected
- Items.
-
-
-
- Gets a collection of the indexes of the Items that are in edit mode.
-
-
- The following example demonstrates how to hide "Add New" button in the
- CommandItemTemplate when Telerik RadGrid is in
- edit/insert mode. The easiest way to check if Telerik RadGrid is in
- edit mode is to check whether the
- (EditIndexes gives a reference to this) is empty.
-
-
-
-
- returns of all data items that are in edit
- mode.
-
-
-
- Gets a collection of the currently selected GridDataItems
- Returns a of all selected data items.
-
-
- Gets the data key value of the selected row in a RadGrid control.
- The data key value of the selected row in a RadGrid control.
-
- The following code example demonstrates how to use the
- SelectedValue property to determine the data key value of the
- selected row in a RadGrid control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
-
- Sub RadGrid1_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
-
- ' Display the primary key value of the selected row.
- Label1.Text = "The primary key value of the selected row is " & _
- RadGrid1.SelectedValue.ToString() & "."
-
- End Sub
-
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head runat="server">
- <title>RadGrid SelectedValue Example</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <h3>
- RadGrid SelectedValue Example</h3>
- <asp:Label ID="Label1" ForeColor="Red" runat="server" />
- <radG:RadGrid ID="RadGrid1" DataSourceID="SqlDataSource1"
- OnSelectedIndexChanged="RadGrid1_SelectedIndexChanged"
- runat="server">
- <MasterTableView DataKeyNames="CustomerID">
- <Columns>
- <radG:GridButtonColumn CommandName="Select" Text="Select" />
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource ID="SqlDataSource1" SelectCommand="SELECT * FROM [Customers]"
- runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" />
- </form>
- </body>
- </html>
-
-
-
-
- <%@ Page Language="C#" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
- <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <script runat="server">
- protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e)
- {
- // Display the primary key value of the selected row.
- Label1.Text = "The primary key value of the selected row is " +
- RadGrid1.SelectedValue.ToString() + ".";
- }
- </script>
-
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head runat="server">
- <title>RadGrid SelectedValue Example</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <h3>
- RadGrid SelectedValue Example</h3>
- <asp:Label ID="Label1" ForeColor="Red" runat="server" />
- <radG:RadGrid ID="RadGrid1" DataSourceID="SqlDataSource1" OnSelectedIndexChanged="RadGrid1_SelectedIndexChanged"
- runat="server">
- <MasterTableView DataKeyNames="CustomerID">
- <Columns>
- <radG:GridButtonColumn CommandName="Select" Text="Select" />
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server And connects -->
- <!-- To the Northwind sample database. Use an ASP.NET -->
- <!-- expression To retrieve the connection String value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource ID="SqlDataSource1" SelectCommand="SELECT * FROM [Customers]"
- runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" />
- </form>
- </body>
- </html>
-
-
-
-
-
- The EditItems collection contains InPlace
- edit mode items. When you switch the edit type to EditForms, the
- EditItems collection holds the currently edited items but not
- their EditFormItems (which in this case hold the new values). See
- this help article for more
- details.
-
- You should not use this property to check whether there are items in edit mode.
- The better approach is to use property instead.
-
-
-
- Gets a collection of all GridItems in edit mode. See the Remarks
- for more info.
-
- of all items that are in edit mode.
-
-
-
- Gets a reference to the object that allows
- you to set the appearance of the selected item in a Telerik RadGrid
- control.
-
-
- A reference to the GridTableItemStyle that represents the style of the selected
- item in a Telerik RadGrid control.
-
- Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework
-
- The following code example demonstrates how to use the SelectedItemStyle property
- to define a custom style for the selected item in a Telerik RadGrid
- control.
-
- <%@ Page Language="VB" %>
-
- <%@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server"
- Skin="">
- <SelectedItemStyle BackColor="red" />
- <MasterTableView>
- <Columns>
- <radG:GridButtonColumn
- Text="Select"
- UniqueName="Select"
- CommandName="Select">
- </radG:GridButtonColumn>
- </Columns>
- </MasterTableView>
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<$ ConnectionStrings>"
- SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- </div>
- </form>
- </body>
- </html>
-
-
-
- Use the SelectedItemStyle property to control the appearance of the selected
- item in a Telerik RadGrid control. This property is read-only; however,
- you can set the properties of the GridTableItemStyle object it returns. The
- properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadGrid
- control in the form Property-Subproperty, where Subproperty is a property of
- the GridTableItemStyle object (for example,
- SelectedItemStyle-ForeColor).
- Nest a <SelectedItemStyle> element between the opening and closing
- tags of the Telerik RadGrid control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, SelectedItemStyle.ForeColor). Common settings
- usually include a custom background color, foreground color, and font
- properties.
-
-
-
-
- Gets or set a value indicating whether the footer item of the grid will be
- shown.
-
-
- Setting this property will affect all grid tables, unless they specify otherwise
- explicitly.
-
- The default value of this property is false.
-
-
-
- Gets or set a value indicating whether the statusbar item of the grid will be
- shown.
-
-
-
- This property is meaningful when the grid is in AJAX mode, i.e. when
- is set to true.
-
- See this help topic for more
- details.
-
-
- true if the status bar item would be shown, otherwise
- false. The default value of this property is
- false.
-
- Status bar item
-
-
-
- Gets a object that contains variable
- settings related to the status bar.
-
-
-
-
- returns a reference to object.
-
-
-
- Gets or set a value indicating whether the header item of the grid will be
- shown.
-
- This default value for this property is true.
-
- Setting this property will affect all grid tables, unless they specify otherwise
- explicitly.
-
-
-
-
- Gets or sets a value, indicating the total number of items in the data source
- when custom paging is used. Thus the grid "understands" that the data source contains
- the specified number of records and it should fetch merely part of them at a time to
- execute requested operation.
-
-
- int, representing the total number of items in the datasource.
- The default value is 0.
-
-
- If you set a value that is greater than the actual number of items, RadGrid
- will show all available items plus empty pages (or whatever other content you set)
- for the items that exceed the actual number.
- For example you have a data source with 9'000 items and you set
- VirtualItemCount to 10'000. If your page size is 1000, the grid will render 10
- pages and the last page will be empty (or with NoRecordsTemplate if you're using
- such).
-
-
-
-
- Gets a reference to object. The filtering menu
- appears when the filter button on the is clicked.
-
- returns a reference to object.
-
- This property is meaningful only when you have filtering enabled (by setting
- AllowFilteringByColumn="true").
-
-
- The following example demonstrates how to customize the filtering
- menu:
- [ASPX/ASCX] <head
- runat="server">
- <title>Filter menu change</title>
- <style type="text/css">
- .FilterMenuClass1 td
- {
- background-color: white;
- color: green;
- font-size: 10px;
- }
- .FilterMenuClass2 td
- {
- background-color: blue;
- color: white;
- font-size: 15px;
- }
- </style>
- </head>
- <body>
- <form id="form1"
- runat="server">
- <div>
- <script type="text/javascript">
- function GridCreated()
- {
- window.setTimeout(SetFilterMenuClass(this), 500);
- }
- function
- SetFilterMenuClass(gridObject)
- {
- gridObject.FilterMenu.SelectColumnBackColor = "";
- gridObject.FilterMenu.TextColumnBackColor = "";
-
- }
- </script>
- <radG:RadGrid ID="RadGrid1"
- AllowFilteringByColumn="true"
- DataSourceID=
- "AccessDataSource1"
- AllowSorting= "True"
- runat="server">
- <FilterMenu
- CssClass="FilterMenuClass1"></FilterMenu>
- <ClientSettings>
- <ClientEvents OnGridCreated="GridCreated"
- />
- </ClientSettings>
- </radG:RadGrid>
- <br />
- <asp:AccessDataSource ID="AccessDataSource1"
- DataFile="~/Grid/Data/Access/Nwind.mdb"
- SelectCommand= "SELECT TOP 10 CustomerID, CompanyName,
- ContactName, ContactTitle, Address, PostalCode FROM Customers"
- runat= "server"></asp:AccessDataSource>
- <radG:RadGrid ID="RadGrid2"
- DataSourceID="AccessDataSource1"
- AllowSorting="True"
- AllowFilteringByColumn= "true"
- Skin="Windows"
- runat="server">
- <ClientSettings>
- <ClientEvents OnGridCreated="GridCreated"
- />
- </ClientSettings>
- <FilterMenu
- CssClass="FilterMenuClass2"></FilterMenu>
- </radG:RadGrid>
- </div>
- </form>
- </body>
- </html>
-
-
-
-
- Represents a HeaderContextMenu
-
-
-
-
- Gets a collection () of all columns in
- Telerik RadGrid.
-
-
- This is one of the three columns collections in Telerik RadGrid. The
- other two are AutoGeneratedColumns and
- RenderColumns.
-
- returns a of all grid columns.
-
- The example below demonstrates how to use the
- columns collection to define columns declaratively (in the ASPX)
-
-
- this.RadGrid1 = new RadGrid();
-
- this.RadGrid1.NeedDataSource += new GridNeedDataSourceEventHandler(this.RadGrid1_NeedDataSource);
-
- this.RadGrid1.AutoGenerateColumns = false;
- this.RadGrid1.MasterTableView.DataMember = "Customers";
-
- GridBoundColumn boundColumn;
- boundColumn = new GridBoundColumn();
- boundColumn.DataField = "CustomerID";
- boundColumn.HeaderText = "CustomerID";
- this.RadGrid1.MasterTableView.Columns.Add(boundColumn);
-
- ....
- //Add to page controls collection
- this.PlaceHolder1.Controls.Add( RadGrid1 );
-
-
- Me.RadGrid1 = New RadGrid
-
- AddHandler RadGrid1.NeedDataSource, AddressOf Me.RadGrid1_NeedDataSource
- AddHandler RadGrid1.DetailTableDataBind, AddressOf Me.RadGrid1_DetailTableDataBind
-
- Me.RadGrid1.AutoGenerateColumns = False
- Me.RadGrid1.MasterTableView.DataMember = "Customers"
-
- Dim boundColumn As GridBoundColumn
- boundColumn = New GridBoundColumn
- boundColumn.DataField = "CustomerID"
- boundColumn.HeaderText = "CustomerID"
- Me.RadGrid1.MasterTableView.Columns.Add(boundColumn)
-
-
- ....'Add to page controls collection
- Me.PlaceHolder1.Controls.Add(RadGrid1)
-
-
-
-
-
-
- Gets a value indicating whether a detail table is currently binding.
-
-
-
-
-
-
-
- Gets or sets the ID of the control from which the Telerik RadGrid
- control retrieves its list of data items.
-
-
- The ID of a control that represents the data source from which the
- Telerik RadGrid control retrieves its data. The default is
- String.Empty.
-
-
- If the Telerik RadGrid control has already been initialized when
- you set the DataSourceID property.
- This property cannot be set by themes or style sheet themes.
-
-
- The following code example demonstrates how the DataSourceID property of a
- Telerik RadGrid control is used. The Telerik RadGrid
- control is associated to the SqlDataSource control by setting its DataSourceID
- property to "SqlDataSource1", the ID of the SqlDataSource control. When the
- DataSourceID property is set (instead of the DataSource property), the
- Telerik RadGrid control automatically binds to the data source control
- at run time.
-
- <%@ Page Language="VB" <see cref="> <"/>@ Register Assembly="Telerik.Web.UI" Namespace="Telerik.Web.UI" TagPrefix="telerik" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
- <html xmlns="http://www.w3.org/1999/xhtml" >
- <head runat="server">
- <title>Untitled Page</title>
- </head>
- <body>
- <form id="form1" runat="server">
- <div>
- <radG:RadGrid
- DataSourceID="SqlDataSource1"
- ID="RadGrid1"
- runat="server">
- </radG:RadGrid>
- <!-- This example uses Microsoft SQL Server and connects -->
- <!-- to the Northwind sample database. Use an ASP.NET -->
- <!-- expression to retrieve the connection string value -->
- <!-- from the Web.config file. -->
- <asp:SqlDataSource
- ID="SqlDataSource1"
- runat="server"
- ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>"
- SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]">
- </asp:SqlDataSource>
- <asp:Label ID="Label1" runat="server" Text="Label"></asp:Label></div>
- </form>
- </body>
- </html>
-
-
-
-
-
-
-
-
-
-
- Gets or sets a value indicating whether the filtering of all tables in the
- hierarchy will be enabled, unless specified other by
- GridTableView.AllowFilteringByColumn.
-
-
- true, enables filtering for the whole grid. Otherwise,
- false. Default is false.
-
-
-
-
- Gets or sets a value indicating whether the header context menu should be
- enabled.
-
-
-
- true if the header context menu feature is enabled; otherwise,
- false. Default is false.
-
-
-
-
- Gets or sets default path for the grid images when EnableEmbeddedSkins is set to false.
- A string containing the path for the grid images. The default is string.Empty.
-
-
- If this property is not set and EnableEmbeddedSkins is set to false the control will raise exception.
-
-
-
-
-
-
- Gets or sets the value to increment or decrement the spin box when the up or down buttons are clicked.
-
-
-
-
- Gets or sets a value indicating whether the user can use the UP ARROW and DOWN ARROW keys to increment/decrement values.
-
-
-
-
- Gets or sets a value indicating whether the user can use the MOUSEWHEEL to increment/decrement values.
-
-
-
- This enumeration determines the direction in which child items will open.
-
- When set to Auto the direction is determined by the
- following rules
-
- If the item is top level and the parent item flow is
- Horizontal the direction will be Down.
- If the item is top level and the parent item flow is
- Vertical the direction will be Right.
- If the item is subitem (a child of another menu item rather than the
- RadMenu itself) the direction is
- Right.
-
- Note:
- If there is not enough room for the child items to
- open the expand direction is inverted. For example Right becomes
- Left, Down becomes Up and vice
- versa.
-
-
-
-
- The direction is determined by parent's ItemFlow and
- level.
-
-
-
- Child items open above their parent.
-
-
- Child items open below their parent.
-
-
- Child items open from the left side of their parent.
-
-
- Child items open from the right side of their parent.
-
-
- Represents the different ways menu items can flow.
-
- The ItemFlow enumeration is used to specify the flow of submenu
- items.
-
-
-
-
- Items will flow one below the other
-
-
-
-
- Items will flow one after another
-
-
-
-
-
-
-
-
-
-
-
-
- Provides data for the events of the control.
-
-
-
-
- Initializes a new instance of the
- RadMenuEventArgs class.
-
-
- A RadMenuItem which represents an item in the
- RadMenu control.
-
-
-
-
- Gets the referenced RadMenuItem in the
- RadMenu control when the event is raised.
-
-
- The referenced item in the RadMenu control when
- the event is raised.
-
-
- Use this property to programmatically access the item referenced in the
- RadMenu when the event is raised.
-
-
-
-
- Represents the method that handles the events provided by the control.
-
-
-
- Represents an item in the control.
-
-
- The control is made up of items. Items which are immediate children
- of the menu are root items. Items which are children of root items are child items.
-
-
- An item usually stores data in two properties, the property and
- the property. The value of the property is displayed
- in the control, and the
- property is used to store additional data.
-
- To create items, use one of the following methods:
-
-
- Use declarative syntax to define items inline in your page or user control.
-
-
- Use one of the constructors to dynamically create new instances of the
- class. These items can then be added to the
- Items collection of another item or menu.
-
-
- Data bind the control to a data source.
-
-
-
- When the user clicks an item, the control can navigate
- to a linked Web page, post back to the server or select that item. If the
- property of an item is set, the
- RadMenu control navigates to the linked page. By default, a linked page
- is displayed in the same window or frame. To display the linked content in a different
- window or frame, use the property.
-
-
- Represents a single item in the RadMenu class.
-
-
- The RadMenu control is made up of a hierarchy of menu items
- represented by RadMenuItem objects. Menu items at the top level (level 0)
- that do not have a parent menu item are called root or top-level menu items. A
- menu item that has a parent menu item is called a submenu item. All root menu
- items are stored in the Items collection of the
- menu. Submenu items are stored in a parent menu item's
- Items collection. You can access a menu item's parent
- menu item by using the Owner property.
-
- To create the menu items for a RadMenu control, use one of the
- following methods:
-
- Use declarative syntax to create static menu items.
- Use a constructor to dynamically create new instances of the
- RadMenuItem class. These RadMenuItem objects can then be added to the
- Items collection of their owner.
- Bind the Menu control to a data source.
-
-
- When the user clicks a menu item, the Menu control can either navigate
- to a linked Web page or simply post back to the server. If the
- NavigateUrl property of a menu item is set, the
- RadMenu control navigates to the linked page. By default, a linked page
- is displayed in the same window or frame as the RadMenu
- control. To display the linked content in a different window or frame, use the
- Target property.
-
-
- Each menu item has a Text and a
- Value property. The value of the Text property
- is displayed in the RadMenu control, while the Value property is
- used to store any additional data about the menu item.
-
-
-
-
-
- Highlights the path from the item to the top of the menu.
-
-
- The HighlightPath method applies the "rmFocused" CSS class to the item and
- his ancestor items. As a results the "path" from the top level to that specific item
- is highlighted.
-
-
-
-
- Removes the item from its container
-
-
-
- Creates a copy of the current RadMenuItem object.
- A RadMenuItem which is a copy of the current one.
-
- Use the Clone method to create a copy of the current item. All
- properties of the clone are set to the same values as the current ones. Child items are
- not cloned.
-
-
-
- Initializes a new instance of the RadMenuItem class.
-
- Use this constructor to create and initialize a new instance of the
- RadMenuItem class using default values.
-
-
- The following example demonstrates how to add items to
- RadMenu controls.
-
- RadMenuItem item = new RadMenuItem();
- item.Text = "News";
- item.NavigateUrl = "~/News.aspx";
-
- RadMenu1.Items.Add(item);
-
-
- Dim item As New RadMenuItem()
- item.Text = "News"
- item.NavigateUrl = "~/News.aspx"
-
- RadMenu1.Items.Add(item)
-
-
-
-
-
- Initializes a new instance of the RadMenuItem class with the
- specified text data.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadMenuItem class using the specified text.
-
-
-
- The following example demonstrates how to add items to
- RadMenu controls.
-
- RadMenuItem item = new RadMenuItem("News");
-
- RadMenu1.Items.Add(item);
-
-
- Dim item As New RadMenuItem("News")
-
- RadMenu1.Items.Add(item)
-
-
-
- The text of the item. The Text property is set to the value
- of this parameter.
-
-
-
-
- Initializes a new instance of the RadMenuItem class with the
- specified text and URL to navigate to.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadMenuItem class using the specified text and URL.
-
-
-
- This example demonstrates how to add items to RadMenu
- controls.
-
- RadMenuItem item = new RadMenuItem("News", "~/News.aspx");
-
- RadMenu1.Items.Add(item);
-
-
- Dim item As New RadMenuItem("News", "~/News.aspx")
-
- RadMenu1.Items.Add(item)
-
-
-
- The text of the item. The Text property is set to the value
- of this parameter.
-
-
- The url which the item will navigate to. The
- NavigateUrl property is set to the value of this
- parameter.
-
-
-
-
- Gets a object that contains the child items of the current RadMenuItem.
-
-
- A that contains the child items of the current RadMenuItem. By default
- the collection is empty (the item has no children).
-
-
- Use the Items property to access the child items of the RadMenuItem. You can also use the Items property to
- manage the child items - you can add, remove or modify items.
-
-
- The following example demonstrates how to programmatically modify the properties of a child item.
-
- RadMenuItem item = RadMenu1.FindItemByText("Test");
- item.Items[0].Text = "Example";
- item.Items[0].NavigateUrl = "http://www.example.com";
-
-
- Dim item As RadMenuItem = RadMenu1.FindItemByText("Test")
- item.Items(0).Text = "Example"
- item.Items(0).NavigateUrl = "http://www.example.com"
-
-
-
-
-
- Gets the object which contains the current menu item.
-
-
- The object which contains the menu item. It might be an instance of the
- class or the
- class depending on the hierarchy level.
-
-
- The value is of the type which is
- implemented by the and the
- classes. Use the Owner property when
- recursively traversing items in the RadMenu control.
-
-
-
- Gets or sets the data item represented by the item.
-
- An object representing the data item to which the Item is bound to. The
- DataItem property will always return null when
- accessed outside of MenuItemDataBound
- event handler.
-
-
- This property is applicable only during data binding. Use it along with the
- MenuItemDataBound event to perform
- additional mapping of fields from the data item to
- RadMenuItem properties.
-
-
- The following example demonstrates how to map fields from the data item to
-
- RadMenuItem properties. It assumes the user has subscribed to the
- MenuItemDataBound:RadMenu.MenuItemDataBound
- event.
-
-
- private void RadMenu1_MenuItemDataBound(object sender, Telerik.WebControls.ItemStripEventArgs e)
- {
- RadMenuItem item = e.Item;
- DataRowView dataRow = (DataRowView) e.Item.DataItem;
-
- item.ImageUrl = "image" + dataRow["ID"].ToString() + ".gif";
- item.NavigateUrl = dataRow["URL"].ToString();
- }
-
-
- Sub RadMenu1_MenuItemDataBound(ByVal sender As Object, ByVal e As ItemStripEventArgs) Handles RadMenu1.MenuItemDataBound
- Dim item As RadMenuItem = e.Item
- Dim dataRow As DataRowView = CType(e.Item.DataItem, DataRowView)
-
- item.ImageUrl = "image" + dataRow("ID").ToString() + ".gif"
- item.NavigateUrl = dataRow("URL").ToString()
- End Sub
-
-
-
-
- Gets or sets the text caption for the menu item.
- The text of the item. The default value is empty string.
-
- This example demonstrates how to set the text of the item using the
- Text property.
-
- <telerik:RadMenu ID="RadMenu1"
- runat="server">
- <Items>
- <telerik:RadMenuItem Text="News" />
- <telerik:RadMenuItem Text="News" />
- </Items>
- </telerik:RadMenu>
-
-
-
- Use the Text property to specify the text to display for the
- item.
-
-
-
- Gets or sets the value associated with the menu item.
- The value associated with the item. The default value is empty string.
-
- Use the Value property to specify or determine the value associated
- with the item.
-
-
-
- Gets or sets the template for displaying the item.
-
- A ITemplate implemented object that contains the template
- for displaying the item. The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
- To specify common display for all menu items use the
- ItemTemplate property of the
- RadMenu class.
-
-
-
- The following template demonstrates how to add a Calendar control in certain
- menu item.
- ASPX:
- <telerik:RadMenu runat="server" ID="RadMenu1">
-
- </telerik:RadMenu>
-
-
-
- Specifies the settings for child item behavior.
-
- An instance of the MenuItemGroupSettings
- class.
-
-
- You can customize the following settings
-
- item flow
- expand direction
- horizontal offset from the parent item
- vertical offset from the parent item
- width
- height
-
-
- For more information check
- MenuItemGroupSettings.
-
-
-
-
-
- Gets or sets the expand behavior of the menu item.
-
- When set to ExpandMode.WebService the RadMenuItem will populate its children from the web service specified by the RadMenu.WebService and RadMenu.WebServiceMethod properties.
-
-
- On of the MenuItemExpandMode values. The default value is ClientSide.
-
-
-
- Gets or sets the URL to link to when the item is clicked.
-
- The URL to link to when the item is clicked. The default value is empty
- string.
-
-
- The following example demonstrates how to use the NavigateUrl
- property
-
- <telerik:RadMenu id="RadMenu1"
- runat="server">
- <Items>
- <telerik:RadMenuItem Text="News" NavigateUrl="~/News.aspx"
- />
- <telerik:RadMenuItem Text="External URL"
- NavigateUrl="http://www.example.com" />
- </Items>
- </telerik:RadMenu>
-
-
-
- Use the NavigateUrl property to specify the URL to link to when
- the item is clicked. Use "~" (tilde) in front of an URL within the same ASP.NET
- application. When specifying external URL do not forget the protocol (e.g.
- "http://").
-
-
-
-
- Gets or sets a value indicating whether clicking on the item will
- postback.
-
-
- True if the menu item should postback; otherwise
- false. By default all the items will postback provided the user
- has subscribed to the ItemClick event.
-
-
- If you subscribe to the ItemClick all menu
- items will postback. To turn off that behavior you should set the
- PostBack property to false. This property cannot
- be set in design time.
-
-
-
- Gets the RadMenu instance which contains the item.
-
- Use this property to obtain an instance to the
- RadMenu object containing the item.
-
-
-
-
- Sets or gets whether the item is separator. It also represents a logical state of
- the item. Might be used in some applications for keyboard navigation to omit processing
- items that are marked as separators.
-
-
-
-
- Gets or sets a value indicating whether the item is selected.
-
-
- True if the item is selected; otherwise false. The default value is
- false.
-
-
- Only one item can be selected.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the menu item is
- disabled.
-
-
- The CSS class applied when the menu item is disabled. The default value is
- "disabled".
-
-
- By default the visual appearance of disabled menu items is defined in the skin CSS
- file. You can use the DisabledCssClass property to specify unique
- appearance for the menu item when it is disabled.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the menu item is
- opened (its child items are visible).
-
-
- The CSS class applied when the menu item is opened. The default value is
- "expanded".
-
-
- By default the visual appearance of opened menu items is defined in the skin CSS
- file. You can use the ExpandedCssClass property to specify unique
- appearance for the menu item when it is opened.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the menu item is
- focused.
-
-
- The CSS class applied when the menu item is focused. The default value is
- "focused".
-
-
- By default the visual appearance of focused menu items is defined in the skin CSS
- file. You can use the FocusedCssClass property to specify unique
- appearance for the menu item when it is focused.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the item is
- selected.
-
-
- By default the visual appearance of selected items is defined in the skin CSS
- file. You can use the SelectedCssClass property to specify unique
- appearance for a item when it is selected.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the menu item is
- clicked.
-
-
- The CSS class applied when the menu item is clicked. The default value is
- "clicked".
-
-
- By default the visual appearance of clicked menu items is defined in the skin CSS
- file. You can use the ClickedCssClass property to specify unique
- appearance for the menu item when it is clicked.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied on the outmost item element (<LI>).
-
-
- The CSS class applied on the wrapping element (<LI>). The default value is empty string.
-
-
- You can use the OuterCssClass property to specify unique
- appearance for the item.
-
-
-
-
- Gets or sets the target window or frame to display the Web page content linked to
- when the menu item is clicked.
-
-
- The target window or frame to load the Web page linked to when the Item is
- selected. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without
- frames.
-
-
- _parent
- Renders the content in the immediate frameset
- parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without
- frames.
-
-
- The default value is empty string.
-
-
-
- Use the Target property to specify the frame or window that displays the
- Web page linked to when the menu item is clicked. The Web page is specified by
- setting the NavigateUrl property.
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
- The following example demonstrates how to use the Target
- property
- ASPX:
- <telerik:RadMenu runat="server" ID="RadMenu1">
- <Items>
- <telerik:RadMenuItem Target="_blank"
- NavigateUrl="http://www.google.com" />
- </Items>
- </telerik:RadMenu>
-
-
-
-
- Manages the item level of a particular Item instance. This property allows easy
- implementation/separation of the menu items in levels.
-
-
-
- Gets or sets the path to an image to display for the item.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the ImageUrl property to specify the image for the item. If
- the ImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
- The following example demonstrates how to specify the image to display for
- the item using the ImageUrl property.
-
- <telerik:RadMenu id="RadMenu1"
- runat="server">
- <Items>
- <telerik:RadMenuItem ImageUrl="~/Img/inbox.gif" Text="Index"
- />
- <telerik:RadMenuItem ImageUrl="~/Img/outbox.gif" Text="Outbox"
- />
- </Items>
- </telerik:RadMenu>
-
-
-
-
-
- Gets or sets the path to an image to display for the item when the user moves the
- mouse over the item.
-
-
- The path to the image to display when the user moves the mouse over the item. The
- default value is empty string.
-
-
- <telerik:RadMenu id="RadMenu1" runat="server">
- <Items>
- <telerik:RadMenuItem ImageUrl="~/Img/inbox.gif"
- HoveredImageUrl="~/Img/inboxOver.gif" Text="Index" />
- <telerik:RadMenuItem ImageUrl="~/Img/outbox.gif"
- HoveredImageUrl="~/Img/outboxOver.gif" Text="Outbox" />
- </Items>
- </telerik:RadMenu>
-
-
- Use the HoveredImageUrl property to specify the image that will be
- used when the user moves the mouse over the item. If the HoveredImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
-
- Gets or sets the path to an image to display for the item when the user clicks the
- item.
-
-
- The path to the image to display when the user clicks the item. The default value
- is empty string.
-
-
- <telerik:RadMenu id="RadMenu1" runat="server">
- <Items>
- <telerik:RadMenuItem ImageUrl="~/Img/inbox.gif"
- ClickedImageUrl="~/Img/inboxClicked.gif" Text="Index" />
- <telerik:RadMenuItem ImageUrl="~/Img/outbox.gif"
- ClickedImageUrl="~/Img/outboxClicked.gif" Text="Outbox"
- />
- </Items>
- </telerik:RadMenu>
-
-
- Use the ClickedImageUrl property to specify the image that will be
- used when the user clicks the item. If the ClickedImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
- Gets or sets the path to an image to display when the items is disabled.
-
- The path to the image to display when the item is disabled. The default value is
- empty string.
-
-
- Use the DisabledImageUrl property to specify the image that will
- be used when the item is disabled. If the DisabledImageUrl property is
- set to empty string the image specified by the ImageUrl property will
- be used. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
- <telerik:RadMenu id="RadMenu1" runat="server">
- <Items>
- <telerik:RadMenuItem ImageUrl="~/Img/inbox.gif"
- DisabledImageUrl="~/Img/inboxDisabled.gif" Text="Index"
- />
- <telerik:RadMenuItem ImageUrl="~/Img/outbox.gif"
- DisabledImageUrl="~/Img/outboxDisabled.gif" Text="Outbox"
- />
- </Items>
- </telerik:RadMenu>
-
-
-
- Gets or sets the path to an image to display when the items is expanded.
-
- The path to the image to display when the item is expanded. The default value is
- empty string.
-
-
- <telerik:RadMenu id="RadMenu1" runat="server">
- <Items>
- <telerik:RadMenuItem ImageUrl="~/Img/inbox.gif"
- ExpandedImageUrl="~/Img/inboxExpanded.gif" Text="Index"
- />
- <telerik:RadMenuItem ImageUrl="~/Img/outbox.gif"
- ExpandedImageUrl="~/Img/outboxExpanded.gif" Text="Outbox"
- />
- </Items>
- </telerik:RadMenu>
-
-
- Use the ExpandedImageUrl property to specify the image that will
- be used when the item is expanded. If the ExpandedImageUrl property is
- set to empty string the image specified by the ImageUrl property will
- be used. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the item is selected.
-
-
- If the SelectedImageUrl property is not set the ImageUrl
- property will be used when the node is selected.
-
-
-
-
- A collection of RadMenuItem objects in a
- RadMenu control.
-
-
- The RadMenuItemCollection class represents a collection of
- RadMenuItem objects. The RadMenuItem objects in turn represent
- menu items within a RadMenu control.
-
-
- Use the indexer to programmatically retrieve a
- single RadMenuItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of menu items in the collection.
-
-
- Use the Add method to add menu items in the collection.
-
-
- Use the Remove method to remove menu items from the
- collection.
-
-
-
-
-
-
-
- Initializes a new instance of the class.
-
- The owner of the collection.
-
-
-
- Appends the specified object to the end of the current .
-
-
- The to append to the end of the current .
-
-
- The following example demonstrates how to programmatically add items in a
- RadMenu control.
-
- RadMenuItem newsItem = new RadMenuItem("News");
- RadMenu1.Items.Add(newsItem);
-
-
- Dim newsItem As RadMenuItem = New RadMenuItem("News")
- RadMenu1.Items.Add(newsItem)
-
-
-
-
-
- Searches the RadMenuItemCollection control for the first
- RadMenuItem with a Text property equal to
- the specified value.
-
-
- A RadMenuItem whose Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the RadMenu control for the first
- RadMenuItem with a Text property equal to
- the specified value.
-
-
- A RadMenuItem whose Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadMenuItemCollection control for the first
- RadMenuItem with a Value property equal
- to the specified value.
-
-
- A RadMenuItem whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the RadMenu control for the first
- RadMenuItem with a Value property equal
- to the specified value.
-
-
- A RadMenuItem whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the items in the collection for a RadMenuItem which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadMenuItem that matches the specified arguments. Null (Nothing) is returned if no node is found.
- This method is not recursive.
-
-
-
- Returns the first RadMenuItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadMenu1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadMenuItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadMenu1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadMenuItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Determines whether the specified object is in the current
- .
-
-
- The object to find.
-
-
- true if the current collection contains the specified object;
- otherwise, false.
-
-
-
-
- Copies the contents of the current into the
- specified array of objects.
-
- The target array.
- The index to start copying from.
-
-
- Appends the specified array of objects to the end of the
- current .
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple items in a single step.
-
- RadMenuItem[] items = new RadMenuItem[] { new RadMenuItem("First"), new RadMenuItem("Second"), new RadMenuItem("Third") };
- RadMenu1.Items.AddRange(items);
-
-
- Dim items() As RadMenuItem = {New RadMenuItem("First"), New RadMenuItem("Second"), New RadMenuItem("Third")}
- RadMenu1.Items.AddRange(items)
-
-
-
- The array of to append to the end of the current .
-
-
-
-
- Determines the index of the specified object in the collection.
-
-
- The to locate.
-
-
- The zero-based index of item within the current ,
- if found; otherwise, -1.
-
-
-
-
- Inserts the specified object in the current
- at the specified index location.
-
-
- The zero-based index location at which to insert the .
-
-
- The to insert.
-
-
-
-
- Removes the specified object from the current
- .
-
-
- The RadMenuItem object to remove.
-
-
-
-
- Removes the object at the specified index
- from the current .
-
-
- The zero-based index of the index to remove.
-
-
-
-
- Gets the object at the specified index in
- the current .
-
-
- The zero-based index of the to retrieve.
-
-
- The at the specified index in the
- current .
-
-
-
- Represents settings controlling child item behavior.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the flow of child items.
-
- One of the ItemFlow enumeration values. The default
- value is Vertical.
-
-
- Use the Flow property to customize the flow of child menu items.
- By default RadMenu mimics the behavior of Windows and child items
- (apart from top level ones) flow vertically.
-
-
-
- Gets or sets the direction in which child items will open.
-
- One of the ExpandDirection enumeration values.
- The default value is Auto.
-
-
- Use the ExpandDirection property to specify different expand
- direction than the automatically determined one. See the
- ExpandDirection description for more information.
-
-
-
-
- Gets or sets a value indicating the horizontal offset of child menu items
- considering their parent.
-
-
- An integer specifying the horizontal offset of child menu items (measured in
- pixels). The default value is 0 (no offset).
-
-
- Use the OffsetX property to change the position where child
- items will appear.
-
- To customize the vertical offset use the OffsetY
- property.
-
-
-
-
-
- Gets or sets a value indicating the vertical offset of child menu items
- considering their parent.
-
-
- An integer specifying the vertical offset of child menu items (measured in
- pixels). The default value is 0 (no offset).
-
-
- Use the OffsetY property to change the position where child
- items will appear.
-
- To customize the horizontal offset use the OffsetX
- property.
-
-
-
-
-
- Gets or sets a value indicating the width of child menu items (the whole item
- group).
-
-
- A Unit that represents the width of the child item group. The
- default value is Unit.Empty.
-
-
- If the total width of menu items exceeds the Width property
- scrolling will be applied.
-
-
-
-
- Gets or sets a value indicating the height of child menu items (the whole item
- group).
-
-
- A Unit that represents the height of the child item group. The
- default value is Unit.Empty.
-
-
- If the total height of menu items exceeds the Height property
- scrolling will be applied.
-
-
-
-
- Gets or sets the number of columns to display in this item group.
-
-
- Specifies the number of columns which are displayed for a given item group. For example,
- if it set to 3, the child items are displayed in three columns.
- The default value is 1.
- Displaying more than 1 column automatically disables scrolling for this group.
-
-
-
-
- Gets or sets whether the columns are repeated vertically or horizontally
-
-
- When this property is set to Vertical,
- items are displayed vertically in columns from top to bottom,
- and then left to right, until all items are rendered.
-
-
- When this property is set to Horizontal,
- items are displayed horizontally in rows from left to right,
- then top to bottom, until all items are rendered.
-
-
-
-
-
- The localization strings to be used in RadScheduler.
-
-
-
- Specifies the view mode of a RadScheduler control.
-
-
-
- A view that spans a single day. All day-events are displayed in a separate row on
- top.
-
-
-
-
- A view that spans seven days. Each day is displayed as in DayView mode and the
- current date is highlighted.
-
-
-
- A view that spans a whole month. The current date is highlighted.
-
-
-
- The Timeline view spans an arbitrary time period. It is divided in slots with
- user selectable duration.
-
-
-
-
- This class should be used in the HTTP Handler declaration for Telerik.Web.UI.WebResource if you need access to the Session object
-
-
-
-
- Populates the Handlers collection
-
-
-
-
- Gets the query string's key name which value determines the handler to be called
-
-
-
-
- Gets the key/value collection of handlers which are currently available
-
-
-
-
- ScriptManager derived class to add the ability to combine multiple
- smaller scripts into a larger one as a way to reduce the number
- of files the client must download
-
-
-
-
- Gets or sets a value indicating if RadScriptManager should check the Telerik.Web.UI.WebResource
- handler existence in the application configuration file.
-
-
- When EnableHandlerDetection set to true, RadScriptManager automatically checks if the
- HttpHandler it uses is registered to the application configuration file and throws
- an exception if the HttpHandler registration missing. Set this property to false
- if your scenario uses a file to output the combined scripts, or when running in Medium trust.
-
-
-
-
- Specifies whether or not multiple script references should be combined into a single file
-
-
- When EnableScriptCombine set to true, the script references of the controls
- on the page are combined to a single file, so that only one <script>
- tag is output to the page HTML
-
-
-
-
- Specifies whether or not the combined output will be compressed.
-
-
- In some cases the browsers do not recognize compressed streams (e.g. if IE 6 lacks
- an update installed). In some cases the Telerik.Web.UI.WebResource handler
- cannot determine if to compress the stream. Set this property
- to Disabled
- if you encounter that problem.
- The OutputCompression property works only when
- EnableScriptCombine is set to true.
-
-
-
-
- Specifies the URL of the HTTPHandler that combines and serves the scripts.
-
-
-
- The HTTPHandler should either be registered in the application configuration
- file, or a file with the specified name should exist at the location, which
- HttpHandlerUrl points to.
-
-
- If a file is to serve the files, it should inherit the class Telerik.Web.UI.WebResource
-
-
-
-
-
- Summary description for DictionarySorter.
-
-
-
-
- Saves the dictionary to a file.
-
- The output file name.
-
-
-
- Load a word list from a file.
-
- The import file name.
-
-
-
- Load a word list from a StreamReader.
-
- The import reader.
-
-
- "Vowels" to test for
-
-
- Prefixes when present which are not pronounced
-
-
- Maximum length of an encoding, default is 4
-
-
- Encode a value with Double Metaphone
-
- @param value string to encode
- @return an encoded string
-
-
- Encode a value with Double Metaphone, optionally using the alternate
- encoding.
-
- @param value string to encode
- @param alternate use alternate encode
- @return an encoded string
-
-
- Check if the Double Metaphone values of two string values
- are equal.
-
- @param value1 The left-hand side of the encoded {@link string#equals(Object)}.
- @param value2 The right-hand side of the encoded {@link string#equals(Object)}.
- @return true if the encoded strings are equal;
- false otherwise.
- @see #isDoubleMetaphoneEqual(string,string,bool)
-
-
- Check if the Double Metaphone values of two string values
- are equal, optionally using the alternate value.
-
- @param value1 The left-hand side of the encoded {@link string#equals(Object)}.
- @param value2 The right-hand side of the encoded {@link string#equals(Object)}.
- @param alternate use the alternate value if true.
- @return true if the encoded strings are equal;
- false otherwise.
-
-
- Returns the maxCodeLen.
- @return int
-
-
- Sets the maxCodeLen.
- @param maxCodeLen The maxCodeLen to set
-
-
- Handles 'A', 'E', 'I', 'O', 'U', and 'Y' cases
-
-
- Handles 'C' cases
-
-
- Handles 'CC' cases
-
-
- Handles 'CH' cases
-
-
- Handles 'D' cases
-
-
- Handles 'G' cases
-
-
- Handles 'GH' cases
-
-
- Handles 'H' cases
-
-
- Handles 'J' cases
-
-
- Handles 'L' cases
-
-
- Handles 'P' cases
-
-
- Handles 'R' cases
-
-
- Handles 'S' cases
-
-
- Handles 'SC' cases
-
-
- Handles 'T' cases
-
-
- Handles 'W' cases
-
-
- Handles 'X' cases
-
-
- Handles 'Z' cases
-
-
- Complex condition 0 for 'C'
-
-
- Complex condition 0 for 'CH'
-
-
- Complex condition 1 for 'CH'
-
-
- Complex condition 0 for 'L'
-
-
- Complex condition 0 for 'M'
-
-
- Determines whether or not a value is of slavo-germanic orgin. A value is
- of slavo-germanic origin if it contians any of 'W', 'K', 'CZ', or 'WITZ'.
-
-
- Determines whether or not a character is a vowel or not
-
-
- Determines whether or not the value starts with a silent letter. It will
- return true if the value starts with any of 'GN', 'KN',
- 'PN', 'WR' or 'PS'.
-
-
- Cleans the input
-
-
- Gets the character at index index if available, otherwise
- it returns Character.MIN_VALUE so that there is some sort
- of a default
-
-
- Shortcut method with 1 criteria
-
-
- Shortcut method with 2 criteria
-
-
- Shortcut method with 3 criteria
-
-
- Shortcut method with 4 criteria
-
-
- Shortcut method with 5 criteria
-
-
- Shortcut method with 6 criteria
-
-
- * Determines whether value contains any of the criteria
- starting
- * at index start and matching up to length length
-
-
- Inner class for storing results, since there is the optional alternate
- encoding.
-
-
-
- Initializes the length and offset arrays as well as the distance matrix.
-
-
-
-
- Finds possible suggestions for a misspelled word.
-
- the misspelled word string
- array of suggestion replacement strings
-
-
-
- Calculates Levenshtein distance for two given strings.
-
- String 1.
- String 2.
- Edit Distance.
-
-
-
- A custom interface that defines the access to the custom dictionary.
- It can be used to replace the custom dictionary storage mechanism and store the words in a database or on a remote computer.
-
-
-
-
- Reads a word from the storage. It should return null if no more words are present.
-
-
-
-
-
- Adds a new custom word.
-
- the new word
-
-
-
- The directory that contains the custom dictionary file.
- Necessary only for file based storage -- it is set to the physical directory corresponding to RadSpell's DictPath property setting.
-
-
-
-
- The language for the custom dictionary. It is usually a culture name like en-US or de-DE.
-
-
-
-
- A custom appendix string that can be used to distinguish different custom dictionaries. It is passed the CustomAppendix of the RadSpell object. This way one can create different dictionaries for John and Mary.
-
-
-
-
- This is the .NET 1.x implementation.
- The .NET 2.0 one gets into an infinite loop when using the WordComparer.
-
-
-
-
- Summary description for WordComparer.
-
-
-
-
- ISpellCheckProvider interface -- defines the behavior that we need
- from a component to do spell checking.
-
-
-
-
- Summary description for TelerikSpellCheckProvider.
-
-
-
-
- Create a new RadSpellChecker object. You need to pass a correct path to the folder that contains the dictionary files (*.TDF)
-
-
- The method expects local paths. E.g. "C:\SomeFolder\RadControls\Spell\TDF". Transform URL's to local paths with the method.
- C#
-
- SpellChecker checker = new SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"));
-
- VB.NET
-
-
- Dim checker As SpellChecker
- checker = New SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"))
-
-
-
-
-
- Cleans up any resources held by the SpellChecker object. It is an alias of the Dispose method.
-
-
-
-
- Performs the actual spellchecking. It will be automatically called by the Errors property accessor.
-
- -- a collection with all the errors found.
-
-
-
- Adds a new word to the custom dictionary. It first checks if the word is already present in the current base or custom dictionaries.
-
- The new custom word.
-
-
-
- Clean up used resources.
-
-
-
-
- Sets the text to be spellchecked. It can be plain text or HTML.
-
-
- This property can be used to pass the text to the spellchecker engine programmatically. The engine can deal with plaintext or any HTML-like format.
- It ignores text inside angle brackets (<>) and transforms HTML entities to their character values. E.g. & becomes &
- C#:
-
- using (SpellChecker checker = new SpellChecker(Server.MapPath("~/RadControls/Spell/TDF")))
- {
- checker.Text = text;
- return checker.Errors;
- }
-
- VB.NET
-
- Dim checker As SpellChecker
- Try
- checker = New SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"))
- checker.Text = text
- Return checker.Errors
- Finally
- checker.Dispose()
- End Try
-
-
-
-
-
- The language of the dictionary to be used for spellchecking. It usually is the same as the corresponding TDF file (without the extension).
-
-
- To spellcheck in German you have to have de-DE.tdf inside your dictionary folder, and set DictionaryLanguage to "de-DE"
- C#:
-
- spellChecker.DictionaryLanguage = "de-DE";
-
- VB.NET
-
- spellChecker.DictionaryLanguage = "de-DE"
-
-
- The default is en-US
-
-
-
- The folder path that contains the TDF files.
-
-
- The method expects local paths. E.g. "C:\SomeFolder\RadControls\Spell\TDF". Transform URL's to local paths with the method.
- C#
-
- SpellChecker checker = new SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"));
-
- VB.NET
-
-
- Dim checker As SpellChecker
- checker = New SpellChecker(Server.MapPath("~/RadControls/Spell/TDF"))
-
-
-
-
- The suffix that gets appended to the custom dictionary file name. It is usually a user specific string that allows to distinguish dictionaries for different users.
- Default filenames are Language + CustomAppendix + ".txt".
- The default is -Custom
-
-
-
-
- Specifies the edit distance. If you increase the value, the checking speed decreases but more suggestions are presented. It does not do anything for the phonetic spellchecking.
-
- The default is 1
-
-
-
- Specifies whether or not to check words in CAPITALS (e.g. "UNESCO")
-
- The default is false
-
-
-
- Specifies whether or not to count repeating words as errors (e.g. "very very")
-
- The default is false
-
-
-
- Specifies whether or not to check words in Capitals (e.g. "Washington")
-
- The default is true
-
-
-
- Specifies whether or not to check words containing numbers (e.g. "l8r")
-
- The default is false
-
-
-
- Specifies the type name for the custom spell check provider
-
-
-
-
- Specifies whether RadSpell should use the internal spellchecking algorithm or try to use Microsoft Word. The possible values are defined in the enum.
-
- The default is PhoneticProvider
-
-
-
- Configures the spellchecker engine, so that it knows whether to skip URL's, email addresses, and filenames and not flag them as erros.
-
-
-
-
-
- Manipulate the custom dictionary source. The new value must implement ICustomDictionarySource.
-
-
-
-
- The fully qualified name of the type that will be used for the custom dictionary storage. The type name must include the assembly, culture and public key token.
- A new instance will be created internally unless you set CustomDictionarySource directly.
-
-
-
-
- The errors after the last spellcheck. The getter method will call automatically that.
-
-
-
-
-
- Contains the information about a spellcheck error. The most important properties are the mistaken word and its offset in the source text.
-
-
-
-
- The index of the misspelled word
-
-
-
-
- The offset in the source text. It is useful for locating the original word and replacing it with one of the suggestions.
-
-
-
-
- The original word that the spellchecker has determined to be wrong.
-
-
-
-
- Suggestions for replacing the mistaken word.
-
-
-
-
-
- A collection that stores objects.
-
-
-
-
-
-
-
- Initializes a new instance of .
-
-
-
-
-
-
- Initializes a new instance of .
-
-
-
-
-
- Adds a with the specified value to the
- .
-
- The to add.
-
- The index at which the new element was inserted.
-
-
-
-
-
- Copies the elements of an array to the end of the .
-
-
- An array of type containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
-
- Adds the contents of another to the end of the collection.
-
-
-
- A containing the objects to add to the collection.
-
-
- None.
-
-
-
-
-
- Gets a value indicating whether the
- contains the specified .
-
- The to locate.
-
- if the is contained in the collection;
- otherwise, .
-
-
-
-
-
- Copies the values to a one-dimensional instance at the
- specified index.
-
- The one-dimensional that is the destination of the values copied from .
- The index in where copying begins.
-
- None.
-
- is multidimensional.-or-The number of elements in the is greater than the available space between and the end of .
- is .
- is less than 's lowbound.
-
-
-
-
- Returns the index of a in
- the .
-
- The to locate.
-
- The index of the of in the
- , if found; otherwise, -1.
-
-
-
-
-
- Inserts a into the at the specified index.
-
- The zero-based index where should be inserted.
- The to insert.
- None.
-
-
-
-
- Returns an enumerator that can iterate through
- the .
-
- None.
-
-
-
-
- Removes a specific from the
- .
-
- The to remove from the .
- None.
- is not found in the Collection.
-
-
-
- Represents the entry at the specified index of the .
-
- The zero-based index of the entry to locate in the collection.
-
- The entry at the specified index of the collection.
-
- is outside the valid range of indexes for the collection.
-
-
-
- The spellcheck provider enumeration.
-
-
-
-
- The default provider. The same as PhoneticProvider
-
-
-
-
- This provider uses the edit distance algorithm. It will work for non-western
- languages.
-
-
-
-
- This provider uses phonetic codes to provide "sounds like" word suggestions. Really effective for English, and less so for other languages.
-
-
-
-
- This provider automates Microsoft Word via its COM Interop interface.
-
-
-
-
- Specifies whether or not to check words in CAPITALS (e.g. 'UNESCO')
-
-
-
-
- Specifies whether or not to check words in Capitals (e.g. 'Washington')
-
-
-
-
- Specifies whether or not to count repeating words as errors (e.g. 'very very')
-
-
-
-
- Specifies whether or not to check words containing numbers (e.g. 'l8r')
-
-
-
-
- A control allowing the ability to combine multiple embedded stylesheet references
- into a larger one as a way to reduce the number of files the client must download
-
-
-
-
- Gets or sets a value indicating if RadStyleSheetManager should check the Telerik.Web.UI.WebResource
- handler existence in the application configuration file.
-
-
- When EnableHandlerDetection set to true, RadStyleSheetManager automatically checks if the
- HttpHandler it uses is registered to the application configuration file and throws
- an exception if the HttpHandler registration missing. Set this property to false
- if your scenario uses a file to output the combined skins, or when running in Medium trust.
-
-
-
-
- Specifies whether or not multiple embedded stylesheet references should be combined into a single file
-
-
- When EnableStyleSheetCombine set to true, the stylesheet references of the controls
- on the page are combined to a single file, so that only one <link>
- tag is output to the page HTML
-
-
-
-
- Specifies whether or not the combined output will be compressed.
-
-
- In some cases the browsers do not recognize compressed streams (e.g. if IE 6 lacks
- an update installed). In some cases the Telerik.Web.UI.WebResource handler
- cannot determine if to compress the stream. Set this property
- to Disabled
- if you encounter that problem.
- The OutputCompression property works only when
- EnableStyleSheetCombine is set to true.
-
-
-
-
- Specifies the URL of the HTTPHandler that combines and serves the stylesheets.
-
-
-
- The HTTPHandler should either be registered in the application configuration
- file, or a file with the specified name should exist at the location, which
- HttpHandlerUrl points to.
-
-
- If a file is to serve the files, it should inherit the class Telerik.Web.UI.WebResource
-
-
-
-
-
- Defines properties that node containers (RadTreeView,
- RadTreeNode) should implement.
-
-
-
- Gets the parent IRadTreeNodeContainer.
-
-
- Gets the collection of child items.
-
- A RadTreeNodeCollection that represents the child
- items.
-
-
- Use this property to retrieve the child items. You can also use it to
- programmatically add or remove items.
-
-
-
- Represents a node in the RadTreeView control.
-
-
- The RadTreeView control is made up of nodes. Nodes which are immediate children
- of the treeview are root nodes. Nodes which are children of root nodes are child nodes.
-
-
- A node usually stores data in two properties, the Text property and
- the Value property. The value of the Text property is displayed
- in the RadTreeView control, and the Value property is used to store additional data.
-
- To create tree nodes, use one of the following methods:
-
-
- Use declarative syntax to define nodes inline in your page or user control.
-
-
- Use one of the constructors to dynamically create new instances of the
- RadTreeNode class. These nodes can then be added to the
- Nodes collection of another node or treeview.
-
-
- Data bind the RadTreeView control to a data source.
-
-
-
- When the user clicks a tree node, the RadTreeView control can navigate
- to a linked Web page, post back to the server or select that node. If the
- NavigateUrl property of a node is set, the
- RadTreeView control navigates to the linked page. By default, a linked page
- is displayed in the same window or frame. To display the linked content in a different
- window or frame, use the Target property.
-
-
-
-
- Initializes a new instance of the RadTreeNode class.
-
- Use this constructor to create and initialize a new instance of the
- RadTreeNode class using default values.
-
-
- The following example demonstrates how to add node to
- RadTreeView controls.
-
- RadTreeNode node = new RadTreeNode();
- node.Text = "News";
- node.NavigateUrl = "~/News.aspx";
-
- RadTreeView1.Nodes.Add(node);
-
-
- Dim node As New RadTreeNode()
- node.Text = "News"
- node.NavigateUrl = "~/News.aspx"
-
- RadTreeView1.Nodes.Add(node)
-
-
-
-
-
- Initializes a new instance of the RadTreeNode class with the
- specified text data.
-
-
- Use this constructor to create and initialize a new instance of the
- RadTreeNode class using the specified text.
-
-
- The following example demonstrates how to add nodes to
- RadTreeView controls.
-
- RadTreeNode node = new RadTreeNode("News");
-
- RadTreeView1.Nodes.Add(node);
-
-
- Dim node As New RadTreeNode("News")
-
- RadTreeView1.Nodes.Add(node)
-
-
-
- The text of the node. The Text property is set to the value
- of this parameter.
-
-
-
-
- Initializes a new instance of the RadTreeNode class with the
- specified text and value.
-
-
- Use this constructor to create and initialize a new instance of the
- RadTreeNode class using the specified text and value.
-
-
- This example demonstrates how to add nodes to RadTreeView
- controls.
-
- RadTreeNode node = new RadTreeNode("News", "NewsValue");
-
- RadTreeView1.Nodes.Add(node);
-
-
- Dim node As New RadTreeNode("News", "NewsValue")
-
- RadTreeView1.Nodes.Add(node)
-
-
-
- The text of the node. The Text property is set to the value
- of this parameter.
-
-
- The value of the node. The Value property is set to the value of this
- parameter.
-
-
-
-
- Initializes a new instance of the RadTreeNode class with the
- specified text, value and URL.
-
-
- Use this constructor to create and initialize a new instance of the
- RadTreeNode class using the specified text, value and URL.
-
-
- This example demonstrates how to add nodes to RadTreeView
- controls.
-
- RadTreeNode node = new RadTreeNode("News", "NewsValue", "~/News.aspx");
-
- RadTreeView1.Nodes.Add(node);
-
-
- Dim node As New RadTreeNode("News", "NewsValue", "~/News.aspx")
-
- RadTreeView1.Nodes.Add(node)
-
-
-
- The text of the node. The Text property is set to the value
- of this parameter.
-
-
- The value of the node. The Value property is set to the value of this
- parameter.
-
-
- The url which the node will navigate to. The
- NavigateUrl property is set to the value of this
- parameter.
-
-
-
-
- Returns the full path (location) of the node delimited by the specified character.
-
- The character to use as a delimiter
- Returns the full path of the node delimited by the specified character.
-
-
-
- Collapses recursively all child nodes of the node.
-
-
-
-
- Expands all parent nodes of the node.
-
-
-
-
- Inserts a node before the current node.
-
- The node to be inserted.
-
-
-
- Inserts a node after the current node.
-
- The node to be inserted.
-
-
-
- Checks if the current node is ancestor of another node.
-
- The node to check for.
-
- True if the current node is ancestor of the other node; otherwise false.
-
-
-
-
- Checks if the current node is descendant of another node node.
-
- The node to check for.
-
- True if the current node is descendant of the other node; otherwise false.
-
-
-
-
- Toggles Expand/Collapse state of the node.
-
-
-
-
- Expands all child nodes of the node.
-
-
-
-
- Expands all parent nodes of the node.
-
-
-
-
- Removes the node from the Nodes collection of its parent
-
-
- The following example demonstrates how to remove a node.
-
- RadTreeNode node = RadTreeView1.Nodes[0];
- node.Remove();
-
-
- Dim node As RadTreeNode = RadTreeView1.Nodes(0)
- node.Remove()
-
-
-
-
-
- Creates a copy of the current object.
-
- A which is a copy of the current one.
-
- Use the Clone method to create a copy of the current node. All
- properties of the clone are set to the same values as the current ones. Child nodes are
- copied as well.
-
-
-
-
- Checks all child nodes of the current node.
-
-
-
-
- Unchecks all child nodes of the current node.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied by default to the node.
-
-
- By default the visual appearance of hovered nodes is defined in the skin CSS
- file. You can use the CssClass property to specify unique
- appearance for the node.
-
-
-
-
- Gets or sets the tooltip shown for the node when the user hovers it with the mouse
-
-
- A string representing the tooltip. The default value is empty string.
-
-
- The ToolTip property is also used as the alt attribute of the node image (in case is set)
-
-
-
-
- Gets or sets a value indicating whether the node is enabled.
-
-
- true if the node is enabled; otherwise false. The default value is true.
-
-
- Disabled nodes cannot be clicked, or expanded.
-
-
-
-
- Gets a object that contains the child nodes of the current RadTreeNode.
-
-
- A that contains the child nodes of the current RadTreeNode. By default
- the collection is empty (the node has no children).
-
-
- Use the Nodes property to access the child nodes of the RadTreeNode. You can also use the Nodes property to
- manage the child nodes - you can add, remove or modify nodes.
-
-
- The following example demonstrates how to programmatically modify the properties of a child node.
-
- RadTreeNode node = RadTreeView1.FindNodeByText("Test");
- node.Nodes[0].Text = "Example";
- node.Nodes[0].NavigateUrl = "http://www.example.com";
-
-
- Dim node As RadTreeNode = RadTreeView1.FindNodeByText("Test")
- node.Nodes(0).Text = "Example"
- node.Nodes(0).NavigateUrl = "http://www.example.com"
-
-
-
-
- Gets the data item that is bound to the node
-
- An Object that represents the data item that is bound to the node. The default value is null (Nothing in Visual Basic),
- which indicates that the node is not bound to any data item. The return value will always be null unless accessed within
- a NodeDataBound event handler.
-
-
- This property is applicable only during data binding. Use it along with the
- NodeDataBound event to perform additional
- mapping of fields from the data item to RadTreeNode properties.
-
-
- The following example demonstrates how to map fields from the data item to
- RadTreeNode properties. It assumes the user has subscribed to the
- NodeDataBound event.
-
- private void RadTreeView1_NodeDataBound(object sender, Telerik.Web.UI.RadTreeNodeEventArgs e)
- {
- e.Node.ImageUrl = "image" + (string)DataBinder.Eval(e.Node.DataItem, "ID") + ".gif";
- e.Node.NavigateUrl = (string)DataBinder.Eval(e.Node.DataItem, "URL");
- }
-
-
- Sub RadTreeView1_NodeDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTreeNodeEventArgs ) Handles RadTreeView1.NodeDataBound
- e.Node.ImageUrl = "image" & DataBinder.Eval(e.Node.DataItem, "ID") & ".gif"
- e.Node.NavigateUrl = CStr(DataBinder.Eval(e.Node.DataItem, "URL"))
- End Sub
-
-
-
-
-
- Gets or sets the text displayed for the current node.
-
-
- The text displayed for the node in the RadTreeView control. The default is empty string.
-
-
- Use the Text property to specify or determine the text that is displayed for the node
- in the RadTreeView control.
-
-
-
-
- Gets or sets custom (user-defined) data associated with the current node.
-
-
- A string representing the user-defined data. The default value is emptry string.
-
-
- Use the Value property to associate custom data with a RadTreeNode object.
-
-
-
-
- Gets or sets the URL to navigate to when the current node is clicked.
-
-
- The URL to navigate to when the node is clicked. The default value is empty string which means that
- clicking the current node will not navigate.
-
-
-
- Setting the NavigateUrl property will disable node selection and as a result the
- NodeClick event won't be raised for the current node.
-
-
-
-
-
- Gets or sets the target window or frame in which to display the Web page content associated with the current node.
-
-
- The target window or frame to load the Web page linked to when the node is
- clicked. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without frames.
-
-
- _parent
- Renders the content in the immediate frameset parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without frames.
-
-
-
- The default value is empty string which means the linked resource will be loaded in the current window.
-
-
-
- Use the Target property to target window or frame in which to display the
- Web page content associated with the current node. The Web page is specified by
- the NavigateUrl property.
-
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
- The Target property is taken into consideration only when the NavigateUrl
- property is set.
-
-
-
- The following example demonstrates how to use the Target property
-
-
- <telerik:RadTreeView id="RadTreeView1" runat="server">
- <Nodes>
- <telerik:RadTreeNode Text="News" NavigateUrl="~/News.aspx"
- Target="_self" />
- <telerik:RadTreeNode Text="External URL" NavigateUrl="http://www.example.com"
- Target="_blank" />
- </Nodes>
- </telerik:RadTreeView>
-
-
-
-
-
- Gets or sets the URL to an image which is displayed next to the text of a node.
-
-
- The URL to the image to display for the node. The default value is empty
- string which means by default no image is displayed.
-
-
- Use the ImageUrl property to specify a custom image that will be
- displayed before the text of the current node.
-
-
-
- The following example demonstrates how to specify the image to display for
- the node using the ImageUrl property.
-
-
- <telerik:RadTreeView id="RadTreeView1" runat="server">
- <Nodes>
- <telerik:RadTreeNodeImageUrl="~/Img/inbox.gif"
- Text="Index"></telerik:RadTreeNode>
- <telerik:RadTreeNodeImageUrl="~/Img/outbox.gif"
- Text="Outbox"></telerik:RadTreeNode>
- <telerik:RadTreeNodeImageUrl="~/Img/trash.gif"
- Text="Trash"></telerik:RadTreeNode>
- <telerik:RadTreeNodeImageUrl="~/Img/meetings.gif"
- Text="Meetings"></telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeView>
-
-
-
-
-
- Gets or sets the category of the node.
-
-
- The Category property is similar to the Value property. You
- can use it to associate custom data with the node.
-
-
- This example illustrates how to use the Category property during the NodeDataBound event.
-
-
- protected void RadTreeView1_NodeDataBound(object sender, RadTreeNodeEventArgs e)
- {
- //"NodeCategory" is the database column which provides data for the Category property.
- e.Node.Category = DataBinder.Eval(e.Node.DataItem, "NodeCategory").ToString();
- }
-
-
- Protected Sub RadTreeView1_NodeDataBound(ByVal sender As Object, ByVal e As RadTreeNodeEventArgs) Handles RadTreeView1.NodeDataBound
- ' "NodeCategory" is the database column which provides data for the Category property.
- e.Node.Category = DataBinder.Eval(e.Node.DataItem, "NodeCategory")
- End Sub
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied to the node when the mouse hovers it.
-
-
- By default the visual appearance of hovered nodes is defined in the skin CSS
- file. You can use the HoveredCssClass property to specify unique
- appearance for a node when it is hoevered.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied to the node when it is disabled.
-
-
- By default the visual appearance of disabled nodes is defined in the skin CSS
- file. You can use the DisabledCssClass property to specify unique
- appearance for a node when it is disabled.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied to the content
- wrapper of the node.
-
-
- You can use the ContentCssClass property to specify unique
- appearance for a node content area and its children. Useful when using
- CSS sprites.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when node is
- selected.
-
-
- By default the visual appearance of selected nodes is defined in the skin CSS
- file. You can use the SelectedCssClass property to specify unique
- appearance for a node when it is selected.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is expanded.
-
-
- If the ExpandedImageUrl property is not set the ImageUrl property will be
- used when the node is expanded.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is selected.
-
-
- If the SelectedImageUrl property is not set the ImageUrl property will be
- used when the node is selected.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is hovered with the mouse.
-
-
- If the HoveredImageUrl property is not set the ImageUrl property will be
- used when the node is hovered.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is disabled.
-
-
- If the DisabledImageUrl property is not set the ImageUrl property will be
- used when the node is disabled.
-
-
-
-
- Gets the level of the node.
-
-
- An integer representing the level of the node. Root nodes are level 0 (zero).
-
-
-
-
- Gets the RadTreeView which the node is part of.
-
-
-
-
- Gets or sets a value indicating whether clicking on the node will
- postback.
-
-
- True if the node should postback; otherwise
- false.
-
-
- If you subscribe to the NodeClick all nodes
- will postback. To turn off that behavior you can set the
- PostBack property to false.
-
-
-
- Gets or sets a value indicating whether the node is expanded.
-
- true if the node is expanded; otherwise,
- false. The default is false.
-
-
-
-
- Gets or sets a value indicating whether the node is checked or not.
-
-
- True if the node is checked; otherwise false. The default value
- is false
-
-
-
-
- Gets the checked state of the tree node
-
-
- One of the TreeNodeExpandMode values.
-
-
-
-
- Gets or sets a value indicating whether the node is checkable. A checkbox control is rendered
- for checkable nodes.
-
-
- If the CheckBoxes property set to true, RadTreeView automatically displays a checkbox next to each node.
- You can set the Checkable property to false for nodes that do not need to display a checkbox.
-
-
-
-
- Gets or sets a value indicating whether the node is selected.
-
-
- True if the node is selected; otherwise false. The default value is
- false.
-
-
- By default, only one node can be selected. You can enable multiple node selection by setting the
- MultipleSelect property of the
- parent RadTreeView to true
-
-
-
-
- Gets or sets a value indicating whether the node can be dragged and dropped.
-
-
- True if the user is able drag and drop the node; otherwise false.
- The default value is true.
-
-
-
-
- Gets or sets a value indicating whether the use can drag and drop nodes over this
- node.
-
-
- True if the user is able to drag and drop nodes over this node; otherwise
- false. The default value is true.
-
-
-
-
- Gets or sets a value indicating whether the use can edit the text of the node.
-
-
- True if the node is editable; otherwise false. The default value
- is true.
-
-
-
-
- Gets or sets the expand behavior of the tree node.
-
- When set to ExpandMode.ServerSide the RadTreeView will fire a server event (NodeExpand) so you can populate the node on demand.
-
-
- On of the TreeNodeExpandMode values. The default value is
- ClientSide.
-
-
-
-
- A Section 508 element
-
-
-
-
- Gets the previous sibling of the node.
- Gets the previous node sibling in the tree structure or returns null if this is the first node in the respective node group.
-
-
- The previous sibling of the node or null (Nothing) if the node is first in its
- parent RadTreeNodeCollection.
-
-
-
-
- Gets the next sibling of the node.
-
-
- The next sibling of the node or null (Nothing) if the node is last in its
- parent RadTreeNodeCollection.
-
-
-
- Gets or sets the template for displaying the node.
-
-
- An object implementing the ITemplate interface. The default value is a null reference
- (Nothing in Visual Basic), which indicates that this property is not set.
-
-
- To specify common display for all nodes use the property of
- the control.
-
-
-
- The following template demonstrates how to add a Calendar control in certain
- node.
- ASPX:
-
- <telerik: RadTreeView runat="server" ID="RadTreeView1">
- <Nodes>
- <telerik:RadTreeNode Text="Root Node" Expanded="True" >
- <Nodes>
- <telerik:RadTreeNode>
- <NodeTemplate>
- <asp:Calendar ID="Calendar1" runat="server"></asp:Calendar>
- </NodeTemplate>
- </telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeView>
-
-
-
-
-
- Gets the full path (location) of the node.
-
-
- A slash delimited path of the node. The path is constructed based on the Text property
- of the node and its parents. For example if the Text of the node it "Houston", its parent node is "Texas" and its parent (root)
- is "U.S.A", FullPath will return "U.S.A/Texas/Houston"
-
-
-
-
- Gets the parent node of the current node.
-
-
- The parent node. If the the node is a root node null (Nothing) is returned.
-
-
-
-
- Gets or sets a value indicating the ID of the displayed for the current node.
-
-
- A string representing the ID of the context menu associated with the current node. The default value is empty string.
-
-
- If the ContextMenuID property is not set the first context menu from the collection
- will be used.
-
-
-
-
- Gets or sets a value indicating whether a context menu should be displayed for the current node.
-
-
- True if a context menu should be displayed for the current node; otherwise false. The default
- value is false.
-
-
- Use the EnableContextMenu property to disable the context menu for particular nodes.
-
-
-
-
- A collection of RadTreeNode objects in a
- control.
-
-
- The RadTreeNodeCollection class represents a collection of
- RadTreeNode objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadTreeNode from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of menu items in the collection.
-
-
- Use the Add method to add nodes in the collection.
-
-
- Use the Remove method to remove nodes from the
- collection.
-
-
-
-
-
-
-
- Initializes a new instance of the class.
-
- The owner of the collection.
-
-
-
- Appends the specified object to the end of the current
- .
-
-
- The to append to the end of the current
- .
-
-
- The following example demonstrates how to programmatically add nodes in a control.
-
- RadTreeNode newsNode = new RadTreeNode("News");
- RadTreeView1.Nodes.Add(newsNode);
-
-
- Dim newsNode As RadTreeNode = New RadTreeNode("News")
- RadTreeView1.Nodes.Add(newsNode)
-
-
-
-
-
- Removes the specified object from the current
- .
-
-
- The object to remove.
-
-
-
-
- Removes the object at the specified index
- from the current .
-
-
- The zero-based index of the node to remove.
-
-
-
-
- Determines whether the specified object is in the current
- .
-
-
- The object to find.
-
-
- true if the current collection contains the specified object;
- otherwise, false.
-
-
-
-
- Copies the instances stored in the current
- object to an System.Array object, beginning at the specified
- index location in the System.Array.
-
- The System.Array to copy the instances to.
- The zero-based relative index in array where copying begins.
-
-
- Appends the specified array of objects to the end of the
- current .
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple nodes in a single step.
-
- RadTreeNode[] nodes = new RadTreeNode[] { new RadTreeNode("First"), new RadTreeNode("Second"), new RadTreeNode("Third") };
- RadTreeView1.Nodes.AddRange(nodes);
-
-
- Dim nodes() As RadTreeNode = {New RadTreeNode("First"), New RadTreeNode("Second"), New RadTreeNode("Third")}
- RadTreeView1.Nodes.AddRange(nodes)
-
-
-
- The array of to append to the end of the current
- .
-
-
-
-
- Determines the index of the specified object in the collection.
-
-
- The to locate.
-
-
- The zero-based index of tab within the current ,
- if found; otherwise, -1.
-
-
-
-
- Inserts the specified object in the current
- at the specified index location.
-
- The zero-based index location at which to insert the .
- The to insert.
-
-
-
- Searches all nodes for a RadTreeNode with a Text property
- equal to the specified text.
-
- The text to search for
- A RadTreeNode whose Text property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
-
-
-
- Searches all nodes for a RadTreeNode with a Text property
- equal to the specified text.
-
- The text to search for
- A RadTreeNode whose Text property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches all nodes for a RadTreeNode with a Value property
- equal to the specified value.
-
- The value to search for
- A RadTreeNode whose Value property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
-
-
-
- Searches all nodes for a RadTreeNode with a Value property
- equal to the specified value.
-
- The value to search for
- A RadTreeNode whose Value property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the nodes in the collection for a RadTreeNode which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadTreeNode that matches the specified arguments. Null (Nothing) is returned if no node is found.
- This method is not recursive.
-
-
-
- Returns the first RadTreeNode
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindNode method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTreeView1.FindNode(NodeWithEqualsTextAndValue);
- }
- private static bool NodeWithEqualsTextAndValue(RadTreeNode node)
- {
- if (node.Text == node.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadTreeView1.FindNode(NodeWithEqualsTextAndValue)
- End Sub
- Private Shared Function NodeWithEqualsTextAndValue(ByVal node As RadTreeNode) As Boolean
- If node.Text = node.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
-
-
-
-
-
-
-
-
- Gets the object at the specified index in
- the current .
-
-
- The zero-based index of the to retrieve.
-
-
- The at the specified index in the
- current .
-
-
-
- A hierarchical control used to display a tree of nodes in a web page.
-
-
- The RadTreeView control is used to display a list of nodes in a Web Forms
- page. The RadTreeView control supports the following features:
-
-
-
- Danodeinding that allows the control to be populated from various
- datasources.
-
-
- Programmatic access to the RadTreeView object model
- which allows dynamic creation of treeviews, populating with nodes and customizing the behavior
- by various properties.
-
-
- Customizable appearance through built-in or user-defined skins.
-
-
-
nodes
-
- The RadTreeView control is made up of tree of nodes represented
- by objects. Nodes at the top level (level 0) are
- called root nodes. An node that has a parent node is called a child node. All root
- nodes are stored in the property of the RadTreeView control. Child nodes are
- stored in the property of their parent .
-
-
- Each node has a and a property.
- The value of the property is displayed in the RadTreeView control,
- while the property is used to store any additional data about the node,
- such as data passed to the postback event associated with the node. When clicked, a node can
- navigate to another Web page indicated by the property.
-
-
-
-
-
- Initializes a new instance of the RadTreeView class.
-
-
- Use this constructor to create and initialize a new instance of the RadTreeView
- control.
-
-
- The following example demonstrates how to programmatically create a RadTreeView
- control.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTreeView RadTreeView1 = new RadTreeView();
- RadTreeView1.ID = "RadTreeView1";
-
- if (!Page.IsPostBack)
- {
- //RadTreeView persist its nodes in ViewState (if EnableViewState is true).
- //Hence nodes should be created only on initial load.
-
- RadTreeNode sportNode = new RadTreeNode("Sport");
- RadTreeView1.Nodes.Add(sportNode);
-
- RadTreeNode newsNode = new RadTreeNode("News");
- RadTreeView1.Nodes.Add(newsNode);
- }
-
- PlaceHolder1.Controls.Add(RadTreeView1);
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- Dim RadTreeView1 As RadTreeView = New RadTreeView()
- RadTreeView1.ID = "RadTreeView1"
-
- If Not Page.IsPostBack Then
- 'RadTreeView persist its nodes in ViewState (if EnableViewState is true).
- 'Hence nodes should be created only on initial load.
-
- Dim sportNode As RadTreeNode = New RadTreeNode("Sport")
- RadTreeView1.Nodes.Add(sportNode)
-
- Dim newsNode As RadTreeNode = New RadTreeNode("News")
- RadTreeView1.Nodes.Add(newsNode)
- End If
-
- PlaceHolder1.Controls.Add(RadTreeView1)
- End Sub
-
-
-
-
-
- Gets or sets the template displayed when child nodes are being loaded.
-
-
- The following example demonstrates how to use the LoadingStatusTemplate to display an image.
-
- <telerik:RadTreeView runat="server" ID="RadTreeView1">
- <LoadingStatusTemplate>
- <asp:Image runat="server" ID="Image1" ImageUrl="~/Img/loading.gif" />
- </LoadingStatusTemplate>
- </telerik:RadTreeView>
-
-
-
-
-
- Gets a linear list of all nodes in the RadTreeView control.
-
- An IList<RadTreeNode> containing all nodes (from all hierarchy levels).
-
-
-
- Searches all nodes for a RadTreeNode with a Text property
- equal to the specified text.
-
- The text to search for
- A RadTreeNode whose Text property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
-
-
-
- Searches all nodes for a RadTreeNode with a Text property
- equal to the specified text.
-
- The text to search for
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
- A RadTreeNode whose Text property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
-
-
-
- Searches all nodes for a RadTreeNode with a Value property
- equal to the specified value.
-
- The value to search for
- A RadTreeNode whose Value property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
-
-
-
- Searches all nodes for a RadTreeNode with a Value property
- equal to the specified value.
-
- The value to search for
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
- A RadTreeNode whose Value property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
-
-
-
- Searches all nodes for a RadTreeNode with a NavigateUrl property
- equal to the specified URL.
-
- The URL to search for
- A RadTreeNode whose NavigateUrl property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
-
- The ResolveUrl method is used to resolve NavigateUrl property before comparing it to the specified URL.
-
-
-
-
- Returns the first RadTreeNode
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindNode method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTreeView1.FindNode(NodeWithEqualsTextAndValue);
- }
- private static bool NodeWithEqualsTextAndValue(RadTreeNode node)
- {
- if (node.Text == node.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadTreeView1.FindNode(NodeWithEqualsTextAndValue)
- End Sub
- Private Shared Function NodeWithEqualsTextAndValue(ByVal node As RadTreeNode) As Boolean
- If node.Text = node.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Populates the control from the specified XML string.
-
- The XML string to populate from.
-
-
-
- Populates the control from the specified XML file.
-
- The name of the XML file.
-
-
-
- Searches all nodes for a RadTreeNode which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadTreeNode that matches the specified arguments. Null (Nothing) is returned if no node is found.
-
-
-
- This methods clears the selected nodes of the current RadTreeView instance. Useful when you need to clear node selection after postback.
-
-
-
-
- This methods clears the checked nodes of the current RadTreeView instance. Useful when you need to clear check selection after postback.
-
-
-
-
- Checks all nodes of the current RadTreeView object.
-
-
-
-
- Expands all nodes in the tree.
-
-
-
-
- Collapses all nodes in the tree.
-
-
-
-
- Gets a list of all client-side changes (adding a node, removing a node, changing a node's property) which have occurred.
-
-
- A list of objects which represent all client-side changes the user has performed.
- By default the ClientChanges property returns empty list. Client-changes are recorded if and only if the client-side
- methods trackChanges()/commitChanges() have been invoked.
-
-
- You can use the ClientChanges property to respond to client-side modifications such as
-
- adding a new item
- removing existing item
- clearing the children of an item or the control itself
- changing a property of the item
-
- The ClientChanges property is available in the first postback (ajax) request after the client-side modifications
- have taken place. After this moment the property will return empty list.
-
-
- The following example demonstrates how to use the ClientChanges property
-
- foreach (ClientOperation<RadTreeNode> operation in RadTreeView1.ClientChanges)
- {
- RadTreeNode node = operation.Item;
-
- switch (operation.Type)
- {
- case ClientOperationType.Insert:
- //A node has been inserted - operation.Item contains the inserted node
- break;
- case ClientOperationType.Remove:
- //A node has been inserted - operation.Item contains the removed node.
- //Keep in mind the node has been removed from the treeview.
- break;
- case ClientOperationType.Update:
- UpdateClientOperation<RadTreeNode> update = operation as UpdateClientOperation<RadTreeNode>
- //The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- break;
- case ClientOperationType.Clear:
- //All children of have been removed - operation.Item contains the parent node whose children have been removed. If operation.Item is null then the root nodes have been removed.
- break;
- }
- }
-
-
- For Each operation As ClientOperation(Of RadTreeNode) In RadTreeView1.ClientChanges
- Dim node As RadTreeNode = operation.Item
- Select Case operation.Type
- Case ClientOperationType.Insert
- 'A node has been inserted - operation.Item contains the inserted node
- Exit Select
- Case ClientOperationType.Remove
- 'A node has been inserted - operation.Item contains the removed node.
- 'Keep in mind the node has been removed from the treeview.
- Exit Select
- Case ClientOperationType.Update
- Dim update As UpdateClientOperation(Of RadTreeNode) = TryCast(operation, UpdateClientOperation(Of RadTreeNode))
- 'The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- Exit Select
- Case ClientOperationType.Clear
- 'All children of have been removed - operation.Item contains the parent node whose children have been removed. If operation.Item is Nothing then the root nodes have been removed.
- Exist Select
- End Select
- Next
-
-
-
-
-
- Gets a collection of RadTreeNode objects that represent the nodes in the control
- that display a selected check box.
-
- An IList<RadTreeNode> containing the checked nodes.
-
-
- When check boxes are displayed in the RadTreeView control (by setting the
- CheckBoxes property to true), use the CheckedNodes
- property to determine which nodes display a selected check box. This collection
- is commonly used to iterate through all the nodes that have a selected check
- box in the tree.
-
-
- The CheckedNodes collection is populated using a depth-first traversal of the tree
- structure: each parent node is processed down to its child nodes before the next
- parent node is populated.
-
-
-
- Protected Sub ShowCheckedNodes(ByVal sender As Object, ByVal e As System.EventArgs)
- Dim message As String = String.Empty
- Dim node As RadTreeNode
- For Each node In RadTree1.CheckedNodes
- message += node.FullPath
- Next node
- nodes.Text = message
- End Sub
-
-
- protected void ShowCheckedNodes(object sender, System.EventArgs e)
- {
- string message = string.Empty;
- foreach (RadTreeNode node in RadTree1.CheckedNodes)
- {
- message += node.FullPath + "<br/>";
- }
- nodes.Text = message;
- }
-
-
-
-
-
- Gets the Value of the selected node.
-
-
- The Value of the selected node. If there is no selected node returns empty string.
-
-
-
-
- Gets a collection of RadTreeNode objects that represent the nodes in the control
- that are currently selected.
-
- An IList<RadTreeNode> containing the selected nodes.
-
- This collection is commonly used to iterate through all the nodes that have
- been selected in the tree.
- The SelectedNodes collection is populated using a
- depth-first traversal of the tree structure: each parent node is processed down to
- its child nodes before the next parent node is populated.
-
-
-
-
- Gets a RadTreeNode object that represents the selected node in the RadTreeView
- control.
-
-
- When a node is in selection mode, the user can select a node by clicking on
- the text in the node. Use the SelectedNode property to determine which node is
- selected in the TreeView control.
-
- A node cannot be selected when the TreeView control displays hyperlinks. When
- hyperlinks are displayed, the SelectedNode property always returns a null reference
- (Nothing in Visual Basic).
-
- When the user selects a different node in the RadTreeView control by clicking
- the text in the new node, the NodeClick event is
- raised, by default. If you set the
- MultipleSelect property of the treeview to
- true, end-users can select multiple nodes by holding the Ctrl / Shift keys
- while selecting.
-
-
-
-
- <radT:RadTreeView
- ID="RadTree1"
- runat="server"
- OnNodeClick="NodeClick"
- />
-
- Protected Sub NodeClick(ByVal sender As Object, ByVal NodeEventArgs As RadTreeNodeEventArgs)
- info.Text = String.Empty
- Dim NodeClicked As RadTreeNode = NodeEventArgs.NodeClicked
- info.Text = NodeClicked.Text
- End Sub
-
-
- <radT:RadTreeView
- ID="RadTree1"
- runat="server"
- OnNodeClick="NodeClick"
- />
-
- protected void NodeClick(object sender, RadTreeNodeEventArgs NodeEventArgs)
- {
- info.Text = string.Empty;
- RadTreeNode NodeClicked = NodeEventArgs.NodeClicked;
- info.Text = NodeClicked.Text;
- }
-
-
-
-
- Gets a value indicating whether the RadTreeView control has no nodes.
-
-
- Gets or sets the template for displaying all node in the current RadTreeView.
-
-
- An object implementing the ITemplate interface. The default value is a null reference
- (Nothing in Visual Basic), which indicates that this property is not set.
-
-
-
-
-
- Gets or sets the loading message that is displayed when child nodes are retrieved
- on AJAX calls.
-
-
- This property can be used for localization purposes (e.g. "Loading..." in
- different languages).
-
-
-
- Protected Sub LoadingMessagePositionChanged(ByVal sender As Object, ByVal e As System.EventArgs)
- Select Case LoadingMessagePos.SelectedItem.Value
- Case "Before"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BeforeNodeText
- RadTree1.LoadingMessage = "(loading ..)"
- Case "After"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.AfterNodeText
- RadTree1.LoadingMessage = "(loading ...)"
- Case "Below"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BelowNodeText
- RadTree1.LoadingMessage = "(loading ...)"
- Case "None"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.None
- End Select
- End Sub
-
-
- protected void LoadingMessagePositionChanged(object sender, System.EventArgs e)
- {
- switch (LoadingMessagePos.SelectedItem.Value)
- {
- case "Before" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BeforeNodeText;
- RadTree1.LoadingMessage = "(loading ..)";
- break;
- case "After" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.AfterNodeText;
- RadTree1.LoadingMessage = "(loading ...)";
- break;
- case "Below" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BelowNodeText;
- RadTree1.LoadingMessage = "(loading ...)";
- break;
- case "None" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.None;
- break;
- }
- }
-
-
-
-
-
- Gets a object that contains the root nodes of the current RadTreeView control.
-
-
- A that contains the root nodes of the current RadTreeView control. By default
- the collection is empty (RadTreeView has no children).
-
-
- Use the nodes property to access the root nodes of the RadTreeView control. You can also use the nodes property to
- manage the root nodes - you can add, remove or modify nodes.
-
-
- The following example demonstrates how to programmatically modify the properties of a root node.
-
- RadTreeView1.Nodes[0].Text = "Example";
- RadTreeView1.Nodes[0].NavigateUrl = "http://www.example.com";
-
-
- RadTreeView1.Nodes(0).Text = "Example"
- RadTreeView1.Nodes(0).NavigateUrl = "http://www.example.com"
-
-
-
-
-
- Gets or sets the position of the loading message when child nodes are retrieved
- on AJAX calls.
-
-
-
- Protected Sub LoadingMessagePositionChanged(ByVal sender As Object, ByVal e As System.EventArgs)
- Select Case LoadingMessagePos.SelectedItem.Value
- Case "Before"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BeforeNodeText
- RadTree1.LoadingMessage = "(loading ..)"
- Case "After"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.AfterNodeText
- RadTree1.LoadingMessage = "(loading ...)"
- Case "Below"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BelowNodeText
- RadTree1.LoadingMessage = "(loading ...)"
- Case "None"
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.None
- End Select
- End Sub
-
-
- protected void LoadingMessagePositionChanged(object sender, System.EventArgs e)
- {
- switch (LoadingMessagePos.SelectedItem.Value)
- {
- case "Before" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BeforeNodeText;
- RadTree1.LoadingMessage = "(loading ...)";
- break;
- case "After" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.AfterNodeText;
- RadTree1.LoadingMessage = "(loading ...)";
- break;
- case "Below" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.BelowNodeText;
- RadTree1.LoadingMessage = "(loading ...)";
- break;
- case "None" :
- RadTree1.LoadingStatusPosition = TreeViewLoadingStatusPosition.None;
- break;
- }
- }
-
-
-
-
-
- Gets a value indicating whether the text of the tree nodes are edinodele in the
- browser.
-
-
- End-users can edit the text of tree-nodes by pressing F2 when the node is
- selected or by clicking on a node that is already selected (slow double
- click).
-
- You can disable / enable node editing for specific tree nodes by setting the
- AllowEdit property of the specific
- RadTreeNode.
-
-
-
- After node editing, RadTreeView fires the NodeEdit
- event and you can change the text of the node - the RadTreeNode instance is
- contained in the NodeEdited property of the event arguments and the new text is
- in the NewText property of the event arguments.
-
-
-
-
- <radT:RadTreeView
- ID="RadTree1"
- Runat="server"
- AllowNodeEditing="True"
- OnNodeEdit="HandleNodeEdit"
- />
-
- Protected Sub HandleNodeEdit(ByVal sender As Object, ByVal NodeEvents As RadTreeNodeEventArgs)
- Dim nodeEdited As RadTreeNode = NodeEvents.NodeEdited
- Dim newText As String = NodeEvents.NewText
-
- nodeEdited.Text = newText
- End Sub
-
-
- <radT:RadTreeView
- ID="RadTree1"
- Runat="server"
- AllowNodeEditing="True"
- OnNodeEdit="HandleNodeEdit"
- />
-
- protected void HandleNodeEdit(object sender, RadTreeNodeEventArgs NodeEvents)
- {
- RadTreeNode nodeEdited = NodeEvents.NodeEdited;
- string newText = NodeEvents.NewText;
-
- nodeEdited.Text = newText;
- }
-
-
-
-
-
- Gets a value indicating whether the dotted lines indenting the nodes should be
- displayed or not.
-
-
-
-
- Gets a value indicating whether only the current branch of the treeview is
- expanded.
-
-
- The property closes all nodes that are not parents of the last expanded node.
- This property is only effective on the client browser - in postback modes you need to
- handle the logic yourself.
-
-
-
-
- When set to true displays a checkbox next to each treenode.
-
-
-
-
- Gets or sets a value indicating whether checking (unchecking) a node will check (uncheck) its child nodes.
-
- true if child nodes will be checked (checked) when the user checks (unchecks) their parent node;
- otherwise, false. The default value is false
-
-
-
-
- Gets or sets a value indicating whether RadTreeView should display tri-state checkboxes.
-
-
- true if tri-state checkboxes should be displayed; otherwise, false. The default value is
- false.
-
-
- Enabling three state checkbox support requires the property to be set to true.
-
-
-
-
- When set to true the treeview allows multiple node selection (by holding down ctrl key while selecting nodes)
-
-
-
-
- When set to true enables drag-and-drop functionality
-
-
-
-
- When set to true enables drag-and-drop visual clue (underline) between nodes while draggin
-
-
-
-
- Gets a collection of RadTreeViewContextMenu objects
- that represent the context menus of a RadTreeView control.
-
- A RadTreeViewContextMenuCollection that
- contains all the context menus of the RadTreeView control.
-
-
- By default, if the ContextMenus collection contains RadTreeViewContextMenus,
- the first one is displayed on the right-click of each RadTreeNode. To disable a context menu for a
- RadTreeNode, set its EnableContextMenu
- property to false. To specify a different context menu for a RadTreeNode, use its
- ContextMenuID property.
-
-
- The following code example demonstrates how to populate the ContextMenus
- collection declaratively.
-
- <%@ Page Language="C#" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <nodes>
- <Telerik:RadTreeNode Text="Menu1Item1"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Menu1Item2"></Telerik:RadTreeNode>
- </nodes>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <nodes>
- <Telerik:RadTreeNode Text="Menu2Item1"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Menu2Item2"></Telerik:RadTreeNode>
- </nodes>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets the settings for the web service used to populate nodes when
- ExpandMode set to
- TreeNodeExpandMode.WebService.
-
-
- An WebServiceSettings that represents the
- web service used for populating nodes.
-
-
-
- Use the WebServiceSettings property to configure the web
- service used to populate nodes on demand.
- You must specify both
- Path and
- Method
- to fully describe the service.
-
-
- You can use the LoadingStatusTemplate
- property to create a loading template.
-
-
- In order to use the integrated support, the web service should have the following signature:
-
-
- [ScriptService]
- public class WebServiceName : WebService
- {
- [WebMethod]
- public RadTreeNodeData[] WebServiceMethodName(RadTreeNodeData item, object context)
- {
- // We cannot use a dictionary as a parameter, because it is only supported by script services.
- // The context object should be cast to a dictionary at runtime.
- IDictionary<string, object> contextDictionary = (IDictionary<string, object>) context;
-
- //...
- }
- }
-
-
-
-
-
-
- When set to true, the nodes populated through Load On Demand are persisted on the server.
-
-
-
- Gets the settings for the animation played when a node opens.
-
- An AnnimationSettings that represents the
- expand animation.
-
-
-
- Use the ExpandAnimation property to customize the expand
- animation of RadTreeView. You can specify the
- Type and
- Duration.
- To disable expand animation effects you should set the
- Type to
- AnimationType.None.
- To customize the collapse animation you can use the
- CollapseAnimation property.
-
-
-
- The following example demonstrates how to set the ExpandAnimation
- of RadTreeView.
-
- ASPX:
-
-
- <telerik:RadTreeView ID="RadTreeView1" runat="server">
- <ExpandAnimation Type="OutQuint" Duration="300"
- />
- <Nodes>
- <telerik:RadTreeViewNode Text="News" >
- <Nodes>
- <telerik:RadTreeViewNode Text="CNN" NavigateUrl="http://www.cnn.com"
- />
- <telerik:RadTreeViewNode Text="Google News" NavigateUrl="http://news.google.com"
- />
- </Nodes>
- </telerik:RadTreeViewNode>
- <telerik:RadTreeViewNode Text="Sport" >
- <Nodes>
- <telerik:RadTreeViewNode Text="ESPN" NavigateUrl="http://www.espn.com"
- />
- <telerik:RadTreeViewNode Text="Eurosport" NavigateUrl="http://www.eurosport.com"
- />
- </Nodes>
- </telerik:RadTreeViewNode>
- </Nodes>
-
-
- </telerik:RadTreeView>
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTreeView1.ExpandAnimation.Type = AnimationType.Linear;
- RadTreeView1.ExpandAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadTreeView1.ExpandAnimation.Type = AnimationType.Linear
- RadTreeView1.ExpandAnimation.Duration = 300
- End Sub
-
-
-
-
- Gets the settings for the animation played when a node closes.
-
- An AnnimationSettings that represents the
- collapse animation.
-
-
-
- Use the CollapseAnimation property to customize the expand
- animation of RadTreeView. You can specify the
- Type and
- Duration.
-
- To disable expand animation effects you should set the
- Type to
- AnimationType.None. To customize the expand animation you can
- use the ExpandAnimation property.
-
-
-
- The following example demonstrates how to set the
- CollapseAnimation of RadTreeView.
-
- ASPX:
-
-
- <telerik:RadTreeView ID="RadTreeView1" runat="server">
- <CollapseAnimation Type="OutQuint" Duration="300"
- />
- <Nodes>
- <telerik:RadTreeViewNode Text="News" >
- <Nodes>
- <telerik:RadTreeViewNode Text="CNN" NavigateUrl="http://www.cnn.com"
- />
- <telerik:RadTreeViewNode Text="Google News" NavigateUrl="http://news.google.com"
- />
- </Nodes>
- </telerik:RadTreeViewNode>
- <telerik:RadTreeViewNode Text="Sport" >
- <Nodes>
- <telerik:RadTreeViewNode Text="ESPN" NavigateUrl="http://www.espn.com"
- />
- <telerik:RadTreeViewNode Text="Eurosport" NavigateUrl="http://www.eurosport.com"
- />
- </Nodes>
- </telerik:RadTreeViewNode>
- </Nodes>
-
-
- </telerik:RadTreeView>
-
-
-
-
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTreeView1.CollapseAnimation.Type = AnimationType.Linear;
- RadTreeView1.CollapseAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadTreeView1.CollapseAnimation.Type = AnimationType.Linear
- RadTreeView1.CollapseAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets a collection of objects that define the relationship
- between a data item and the tree node it is binding to.
-
-
- A that represents the relationship between a data item and the tree node it is binding to.
-
-
-
-
- Gets or sets the maximum number of levels to bind to the RadTreeView control.
-
-
- The maximum number of levels to bind to the RadTreeView control. The default is -1, which binds all the levels in the data source to the control.
-
-
- When binding the RadTreeView control to a data source, use the MaxDanodeindDepth
- property to limit the number of levels to bind to the control. For example, setting this property to 2 binds only
- the root nodes and their immediate children. All remaining records in the data source are ignored.
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when a tree node is clicked.
-
-
- The URL of the Web page to post to from the current page when a tree node is clicked.
- The default value is an empty string (""), which causes the page to post back to itself.
-
-
-
-
- Gets or sets the name of the JavaScript function called when a node starts being edited
-
-
-
-
- Gets or sets the name of the JavaScript function called when a node is databound during load on demand
-
-
-
-
- Gets or sets the name of the JavaScript function called when the control is fully
- initialized on the client side.
-
-
-
-
- The name of the JavaScript function that will be called upon click on a treenode. The function must accept a single parameter which is the instance of the node clicked.
- For example if you define OnClientClick="ProcessClientClick", you must define a javascript function defined in the following way (example):
- function ProcessClientClick(node)
- {
- alert("You clicked on: " + node.Text);
- }
-
-
-
-
- The name of the JavaScript function that will be called after click on a treenode. Used for AJAX/callback hooks.
-
-
-
-
- The name of the JavaScript function that will be called when the user highlights a treenode.
-
-
-
-
- The name of the JavaScript function that will be called when the user double clicks on a node.
-
-
-
-
- The name of the JavaScript function that will be called when the mouse hovers away from the TreeView.
-
-
-
-
- The name of the JavaScript function that will be called before the user edits a node
-
-
-
-
- The name of the JavaScript function that will be called after the user edits a node
-
-
-
-
- The name of the JavaScript function that will be called before a node is expanded.
-
-
-
-
- The name of the JavaScript function that will be called after a node is expanded.
-
-
-
-
- The name of the JavaScript function that will be called before a node is collapsed.
-
-
-
-
- The name of the JavaScript function that will be called after a node is collapsed.
-
-
-
-
- The name of the JavaScript function that will be called when the user drops a node onto another node.
-
-
-
-
- The name of the JavaScript function that will be called after the user drops a node onto another node.
-
-
-
-
- The name of the JavaScript function that will be called when the user checks (checkbox) a treenode.
-
-
-
-
- The name of the JavaScript function that will be called after the user checks (checkbox) a treenode.
-
-
-
-
- The name of the JavaScript function that will be called when the user starts dragging a node.
-
-
-
-
- The name of the JavaScript function that will be called when the user moves the mouse while dragging a node.
-
-
-
-
- The name of the JavaScript function that will be called when the user clicks on a context menu item.
-
-
-
-
- The name of the JavaScript function that will be called after the user clicks on a context menu item.
-
-
-
-
- The name of the JavaScript function that will be called when a context menu is to be displayed.
-
-
-
-
- The name of the JavaScript function that will be called after context menu is displayed.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the children of a tree node are about to be populated (for example from web service).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientNodePopulatingHandler(sender, eventArgs)
- {
- var node = eventArgs.get_node();
- var context = eventArgs.get_context();
- context["CategoryID"] = node.get_value();
- }
- </script>
- <telerik:RadTreeView ID="RadTreeView1"
- runat="server"
- OnClientNodePopulating="onClientNodePopulatingHandler">
- ....
- </telerik:RadTreeView>
-
-
- If specified, the OnClientNodePopulating client-side event
- handler is called when the children of a tree node are about to be populated.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with three properties:
-
- get_node(), the instance of the node.
- get_context(), an user object that will be passed to the web service.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the children of a tree node were just populated (for example from web service).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientNodePopulatedHandler(sender, eventArgs)
- {
- var node = eventArgs.get_node();
- alert("Loading finished for " + node.get_text());
- }
- </script>
- <telerik:RadTreeView ID="RadTreeView1"
- runat="server"
- OnClientNodePopulated="onClientNodePopulatedHandler">
- ....
- </telerik:RadTreeView>
-
-
- If specified, the OnClientNodePopulated client-side event
- handler is called when the children of a tree node were just populated.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with one property:
-
- get_node(), the instance of the tree node.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the operation for populating the children of a tree node has failed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientNodePopulationFailedHandler(sender, eventArgs)
- {
- var node = eventArgs.get_node();
- var errorMessage = eventArgs.get_errorMessage();
-
- alert("Error: " + errorMessage);
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadTreeView ID="RadTreeView1"
- runat="server"
- OnClientNodePopulationFailed="onClientNodePopulationFailedHandler">
- ....
- </telerik:RadTreeView>
-
-
- If specified, the OnClientNodePopulationFailed client-side event
- handler is called when the operation to populate the children of a tree node has failed.
- Two parameters are passed to the handler:
-
- sender, the menu client object;
- eventArgs with three properties:
-
- get_node(), the instance of the tree node.
- set_cancel(), set to true to suppress the default action (alert message).
-
-
-
- This event cannot be cancelled.
-
-
-
-
- The name of the JavaScript function that will be called when a key is pressed.
-
-
-
-
- Occurs on the server when a node in the
- control is clicked.
-
-
- The following example demonstrates how to use the NodeClick event to determine the clicked node.
-
- protected void RadTreeView1_NodeClick(object sender, Telerik.Web.UI.RadTreeNodeEventArgs e)
- {
- Response.Write("Clicked node is " + e.Node.Text);
- }
-
-
- Sub RadTreeView1_NodeClick(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTreeNodeEventArgs) Handles RadTreeView1.NodeClick
- Response.Write("Clicked node is " & e.Node.Text)
- End Sub
-
-
-
-
- Occurs when a node is data bound.
-
-
- The NodeDataBound event is raised for each node upon
- danodeinding. You can retrieve the node being bound using the event arguments.
- The DataItem associated with the node can be retrieved using
- the property.
-
- The NodeDataBound event is often used in scenarios when you
- want to perform additional mapping of fields from the DataItem to their respective
- properties in the class.
-
-
-
- The following example demonstrates how to map fields from the data item to
- properties using the NodeDataBound event.
-
- protected void RadTreeView1_NodeDataBound(object sender, Telerik.Web.UI.RadTreeNodeEventArgs e)
- {
- e.Node.ImageUrl = "image" + (string)DataBinder.Eval(e.Node.DataItem, "ID") + ".gif";
- e.Node.NavigateUrl = (string)DataBinder.Eval(e.Node.DataItem, "URL");
- }
-
-
- Sub RadTreeView1_NodeDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTreeNodeEventArgs) Handles RadTreeView1.NodeDataBound
- e.Node.ImageUrl = "image" & DataBinder.Eval(e.Node.DataItem, "ID") & ".gif"
- e.Node.NavigateUrl = CStr(DataBinder.Eval(e.Node.DataItem, "URL"))
- End Sub
-
-
-
-
- Occurs when a node is created.
-
- The NodeCreated event is raised when an node in the control is created,
- both during round-trips and at the time data is bound to the control. The NodeCreated event is not raised for nodes
- which are defined inline in the page or user control.
- The NodeCreated event is commonly used to initialize node properties.
-
-
- The following example demonstrates how to use the NodeCreated event
- to set the ToolTip property of each node.
-
- protected void RadTreeView1_NodeCreated(object sender, Telerik.Web.UI.RadTreeNodeEventArgs e)
- {
- e.Node.ToolTip = e.Node.Text;
- }
-
-
- Sub RadTreeView1_NodeCreated(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTreeNodeEventArgs) Handles RadTreeView1.NodeCreated
- e.Node.ToolTip = e.Node.Text
- End Sub
-
-
-
-
-
- Occurs when a node is expanded.
-
-
-
- The NodeExpand event will be raised for nodes whose property is set to
- ServerSide or ServerSideCallback.
-
-
- The NodeExpand event is commonly used to populate nodes on demand.
-
-
-
- The following example demonstrates how to use the NodeExpand event to populate nodes on demand.
-
- protected void RadTreeView1_NodeExpanded(object sender, Telerik.Web.UI.RadTreeNodeEventArgs e)
- {
- RadTreeNode nodeCreatedOnDemand = new RadTreeNode("Node created on demand");
- e.Node.Nodes.Add(nodeCreatedOnDemand);
- }
-
-
- Sub RadTreeView1_NodeExpanded(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTreeNodeEventArgs) Handles RadTreeView1.NodeExpanded
- Dim nodeCreatedOnDemand As RadTreeNode = New RadTreeNode("Node created on demand")
- e.Node.Nodes.Add(nodeCreatedOnDemand)
- End Sub
-
-
-
-
-
- Occurs when a node is collapsed.
-
-
- The NodeCollapse event is raised only for nodes whose property
- is set to ServerSide.
-
-
-
-
- Occurs when a node is checked.
-
-
-
-
- Occurs when a node (or nodes) is dragged and dropped.
-
-
- The NodeDrop event is commonly used to move nodes from one location into other.
-
-
- The following example demonstrates how to move the dragged nodes in the destination node.
-
- protected void RadTreeView1_NodeDrop(object sender, RadTreeNodeDragDropEventArgs e)
- {
- foreach (RadTreeNode sourceNode in e.DraggedNodes)
- {
- if (!sourceNode.IsAncestorOf(e.DestDragNode))
- {
- sourceNode.Remove();
- e.DestDragNode.Nodes.Add(sourceNode);
- }
- }
- }
-
-
- Protected Sub RadTreeView1_NodeDrop(ByVal sender As Object, ByVal e As RadTreeNodeDragDropEventArgs) Handles RadTreeView1.NodeDrop
- For Each sourceNode As RadTreeNode In e.DraggedNodes
- If Not sourceNode.IsAncestorOf(e.DestDragNode) Then
- sourceNode.Remove()
- e.DestDragNode.Nodes.Add(sourceNode)
- End If
- Next
- End Sub
-
-
-
-
-
- Occurs when a node's text is edited.
-
-
- The NodeEdit event is commonly used to update the property after editing.
-
-
- The following example demonstrates how to update the property after editing
-
- protected void RadTreeView1_NodeEdit(object sender, RadTreeNodeEditEventArgs e)
- {
- RadTreeNode nodeEdited = e.Node;
- string newText = e.Text;
- nodeEdited.Text = newText;
- }
-
-
- Protected Sub HandleNodeEdit(ByVal sender As Object, ByVal e As RadTreeNodeEditEventArgs) Handles RadTreeView1.NodeEdit
- Dim nodeEdited As RadTreeNode = e.Node
- Dim newText As String = e.Text
- nodeEdited.Text = newText
- End Sub
-
-
-
-
-
- Occurs on the server when a item in the is clicked.
-
-
- The context menu will also postback if you navigate to a menu item
- using the [menu item] key and then press [enter] on the menu item that is focused. The
- instance of the clicked menu item is passed to the ContextMenuItemClick event
- handler - you can obtain a reference to it using the eventArgs.Item property.
-
-
-
-
- Telerik RadEditor
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Adds HTML attributes and styles that need to be rendered to the specified . This method is used primarily by control developers.
-
- A that represents the output stream to render HTML content on the client.
-
-
-
- The Enabled property is reset in AddAttributesToRender in order
- to avoid setting disabled attribute in the control tag (this is
- the default behavior). This property has the real value of the
- Enabled property in that moment.
-
-
-
-
- Registers the control with the ScriptManager
-
-
-
-
- Registers the CSS styles for the control
-
-
-
-
- Registers the script descriptors.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Outputs the content of a server control's children to a provided object, which writes the content to be rendered on the client.
-
- The object that receives the rendered content.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Finds the tool with the given name.
-
- The name of the tool to find.
-
-
-
-
-
-
-
- Executed when post data is loaded from the request
-
-
-
-
- Executes during the prerender event. We set the tools file and fill the collections with their default values.
-
-
-
-
- Removes a specific filter from the ContentFilters.
-
- An EditorFilters value
-
-
-
- Add a specific filter to the ContentFilters.
-
- An EditorFilters value
-
-
-
- Used to set the file browser configuration paths for the editor dialogs
-
- A string array containing the paths to set.
- Which dialogs to set the paths to.
- Which paths (view, upload, delete) to set.
-
-
-
- Restores view-state information from a previous request that was saved with the System.Web.UI.WebControls.WebControl.SaveViewState() method.
-
- An object that represents the control state to restore.
-
-
-
- Saves any state that was modified after the System.Web.UI.WebControls.Style.TrackViewState() method was invoked.
-
- An object that contains the current view state of the control; otherwise, if there is no view state associated with the control, null.
-
-
-
- Causes the control to track changes to its view state so they can be stored in the object's System.Web.UI.Control.ViewState property.
-
-
-
-
- Raises the FileDelete event.
-
-
-
-
- Raises the ExportContent event.
-
-
-
-
- Raises the FileUpload event.
-
-
-
-
- Raises the TextChanged event.
-
-
-
-
- Gets the value that corresponds to this Web server control. This property is used primarily by control developers.
-
-
- One of the enumeration values.
-
-
-
-
-
-
-
-
- Gets a reference to the object that
- allows you to set the export file properties
-
-
-
- A reference to the EditorExportSettings that allows you to set the export file properties
-
-
- Use the ExportSettings property to control the export file settings
- This property is read-only;
- however, you can set the properties of the EditorExportSettings object it returns.
- The properties can be set declaratively using one of the following methods:
-
- Place an attribute in the opening tag of the Telerik RadEditor
- control in the form Property-Subproperty, where Subproperty is a property of
- the EditorExportSettings object (for example,
- ExportSettings-FileName).
- Nest a <ExportSettings> element between the opening and closing
- tags of the Telerik RadEditor control.
-
- The properties can also be set programmatically in the form
- Property.Subproperty (for example, ExportSettings.FileName).
-
-
-
-
- Gets or sets a string containing the ID (will search for both server or client ID) of a client object that should be used as a tool provider.
-
-
-
- This property helps significantly reduce the HTML markup and JSON sent from server to the
- client when multiple RadEditor objects with the same tools are used on the same page.
-
- The ToolProviderID can be set to the ID of another RadEditor, or to a custom
- control that implements two clientside methods get_toolHTML and get_toolJSON.
-
-
-
-
-
- Gets a reference to a that can be used to add external CSS files in the editor content area.
-
-
- By default, RadEditor uses the CSS classes available in the current page.
- However, it can be configured to load external CSS files instead. This scenario is
- very common for editors integrated in back-end administration areas, which have one
- set of CSS classes, while the content is being saved in a database and displayed on
- the public area, which has a different set of CSS classes.
- If this property is set the RadEditor loads only the styles
- defined in the CssFiles collection. The styles defined in the current page are not loaded in
- the editor content area and the "Apply Class" dropdown.
-
- If you want to load only a subset of the defined classes you can use the
- CssClasses property.
-
-
-
- A containing the names of the external CSS files that should be
- available in the editor's content area.
-
-
-
-
- Gets the collection containing the colors to put in the Foreground and Background color dropdowns.
-
-
- A StringCollection containing the colors to put in the Foreground and Background
- color dropdowns. Default is an empty StringCollection.
-
-
- The contents of this collection will override the default colors available in
- the Foreground and Background color dropdowns. In order to extend the default set
- you should add the default colors and the new colors.
- Note: Setting this property will affect all color pickers of
- the RadEditor, including those in the table proprties dialogs.
-
-
- This example demonstrates how to put only Red, Green and Blue into the Foreground
- and Background dropdowns.
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
- RadEditor1.Colors.Add("Red")
- RadEditor1.Colors.Add("Green")
- RadEditor1.Colors.Add("Blue")
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- RadEditor1.Colors.Add("Red");
- RadEditor1.Colors.Add("Green");
- RadEditor1.Colors.Add("Blue");
- }
-
-
-
-
- Gets the collection containing the symbols to put in the Symbols dropdown.
-
- A SymbolCollection containing the symbols to put in the Symbols dropdown. Default
- is an empty SymbolCollection.
-
-
- The contents of this collection will override the default symbols available
- in the Symbols dropdown.
- Note: multiple symbols can be added at once by using the
- SymbolCollection.Add() method.
-
-
- This example demonstrates how to put only the english alphabet symbols to the
- Symbols dropdown.
-
- Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
- For i As Integer = 65 To 90
- RadEditor1.Symbols.Add(Convert.ToChar(i))
- Next
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- for (int i=65; i<=90; i++)
- {
- RadEditor1.Symbols.Add(Convert.ToChar(i));
- }
- }
-
-
-
-
-
- Gets the collection containing the links to put in the Custom Links dropdown.
-
- A Link object containing the links to put in the Custom Links dropdown.
-
- The Custom Links dropdown of the RadEditor is a very convenient tool for
- inserting predefined hyperlinks.
- Note: the links can be organized in a tree like
- structure.
-
-
- This example demonstrates how to create a tree like structure of custom links.
-
- Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
- 'Add the root
- RadEditor1.Links.Add("Telerik", "http://www.telerik.com")
- 'Add the Products node And its children
- RadEditor1.Links("Telerik").Add("Products", "http://www.telerik.com/products")
- RadEditor1.Links("Telerik")("Products").Add("RadControls", "http://www.telerik.com/radcontrols")
- RadEditor1.Links("Telerik")("Products").Add("RadEditor", "http://www.telerik.com/RadEditor")
- RadEditor1.Links("Telerik")("Products")("RadEditor").Add("QSF", "http://www.telerik.com/demos/aspnet/Editor/Examples/Default/DefaultCS.aspx")
- 'Add Purchase, Support And Client.Net nodes
- RadEditor1.Links("Telerik").Add("Purchase", "http://www.telerik.com/purchase")
- RadEditor1.Links("Telerik").Add("Support", "http://www.telerik.com/support")
- RadEditor1.Links("Telerik").Add("Client.Net", "http://www.telerik.com/clientnet")
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- //Add the root
- RadEditor1.Links.Add("Telerik", "http://www.telerik.com");
- //Add the Products node and its children
- RadEditor1.Links["Telerik"].Add("Products", "http://www.telerik.com/products");
- RadEditor1.Links["Telerik"]["Products"].Add("RadControls", "http://www.telerik.com/radcontrols");
- RadEditor1.Links["Telerik"]["Products"].Add("RadEditor", "http://www.telerik.com/RadEditor");
- RadEditor1.Links["Telerik"]["Products"]["RadEditor"].Add("QSF", "http://www.telerik.com/demos/aspnet/Editor/Examples/Default/DefaultCS.aspx");
- //Add Purchase, Support and Client.Net nodes
- RadEditor1.Links["Telerik"].Add("Purchase", "http://www.telerik.com/purchase");
- RadEditor1.Links["Telerik"].Add("Support", "http://www.telerik.com/support");
- RadEditor1.Links["Telerik"].Add("Client.Net", "http://www.telerik.com/clientnet");
- }
-
-
-
-
-
- Gets the collection containing the custom font sizes to put in the [Size] dropdown.
-
-
- A string collection containing the custom font sizes to put in the Size dropdown.
- Default is an empty StringCollection.
-
-
- The contents of this collection will override the default font sizes
- available in the [Size] dropdown. In order to extend the default set you should add
- the default font sizes and the new font sizes. The default font sizes are: 1, 2, 3,
- 4, 5, 6 and 7.
- Note: the minimum font size is 1, the maximum is 7.
-
-
- This example demonstrates how to remove the font size 1 from the Size dropdown.
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
- RadEditor1.FontSizes.Add(2)
- RadEditor1.FontSizes.Add(3)
- RadEditor1.FontSizes.Add(4)
- RadEditor1.FontSizes.Add(5)
- RadEditor1.FontSizes.Add(6)
- RadEditor1.FontSizes.Add(7)
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- RadEditor1.FontSizes.Add(2);
- RadEditor1.FontSizes.Add(3);
- RadEditor1.FontSizes.Add(4);
- RadEditor1.FontSizes.Add(5);
- RadEditor1.FontSizes.Add(6);
- RadEditor1.FontSizes.Add(7);
- }
-
-
-
-
-
- Gets the collection containing the custom font names to put in the Font dropdown.
-
-
- A string collection containing the custom font names to put in the Font dropdown.
- Default is an empty StringCollection.
-
-
- The contents of this collection will override the default fonts available in
- the Font dropdown. In order to extend the default set you should add the default
- font names and the new font names. The default font names are: Arial, Comic Sans
- MS, Courier New, Tahoma, Times New Roman, Verdana.
- Note: the fonts must exist on the client computer.
-
-
- This example demonstrates how to add Arial Narrow font to the Font dropdown.
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
- RadEditor1.FontNames.Add("Arial")
- RadEditor1.FontNames.Add("Arial Narrow")
- RadEditor1.FontNames.Add("Comic Sans MS")
- RadEditor1.FontNames.Add("Courier New")
- RadEditor1.FontNames.Add("Tahoma")
- RadEditor1.FontNames.Add("Times New Roman")
- RadEditor1.FontNames.Add("Verdana")
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- RadEditor1.FontNames.Add("Arial");
- RadEditor1.FontNames.Add("Arial Narrow");
- RadEditor1.FontNames.Add("Comic Sans MS");
- RadEditor1.FontNames.Add("Courier New");
- RadEditor1.FontNames.Add("Tahoma");
- RadEditor1.FontNames.Add("Times New Roman");
- RadEditor1.FontNames.Add("Verdana");
- }
-
-
-
-
-
- Gets the collection containing the paragraph styles to put in the Paragraph Style
- dropdown.
-
-
- A NameValueCollection containing the paragraph styles to put in the Paragraph
- Style dropdown. Default is an empty NameValueCollection.
-
-
- The contents of this collection will override the default paragraph styles
- available in the Paragraph Style dropdown.
- Note: RadEditor also supports block format with css class
- set. See the example below.
-
-
- This example demonstrates how to put several paragraph styles in the Paragraph
- Style dropdown.
-
- Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
- 'Add clear formatting
- RadEditor1.Paragraphs.Add("Clear Formatting", "body")
- 'Add the standard paragraph styles
- RadEditor1.Paragraphs.Add("Heading 1", "<h1>")
- RadEditor1.Paragraphs.Add("Heading 2", "<h2>")
- RadEditor1.Paragraphs.Add("Heading 3", "<h3>")
- 'Add paragraph style With block Format And css Class
- RadEditor1.Paragraphs.Add("Heading 2 Bordered", "<h2 class=\"bordered\">")
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- //Add clear formatting
- RadEditor1.Paragraphs.Add("Clear Formatting", "body");
- //Add the standard paragraph styles
- RadEditor1.Paragraphs.Add("Heading 1", "<h1>");
- RadEditor1.Paragraphs.Add("Heading 2", "<h2>");
- RadEditor1.Paragraphs.Add("Heading 3", "<h3>");
- //Add paragraph style with block format and css class
- RadEditor1.Paragraphs.Add("Heading 2 Bordered", "<h2 class=\"bordered\">");
- }
-
-
-
-
-
- Gets the collection containing the custom real font sizes to put in the RealFontSize dropdown.
-
-
- A string collection containing the custom real font sizes to put in the RealFontSize dropdown.
- Default is an empty StringCollection.
-
-
- The contents of this collection will override the default real font sizes available in
- the RealFontSize dropdown.
-
-
- This example demonstrates how to add custom font sizes to the RealFontSize dropdown.
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
- RadEditor1.RealFontSizes.Add("8pt")
- RadEditor1.RealFontSizes.Add("9pt")
- RadEditor1.RealFontSizes.Add("11pt")
- RadEditor1.RealFontSizes.Add("13pt")
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- RadEditor1.RealFontSizes.Add("8pt")
- RadEditor1.RealFontSizes.Add("9pt")
- RadEditor1.RealFontSizes.Add("11pt")
- RadEditor1.RealFontSizes.Add("13pt")
- }
-
-
-
-
-
- Gets the collection containing the CSS classes to put in the [Apply CSS Class] dropdown.
-
-
- A NameValueCollection containing the CSS classes to put in the [Apply CSS Class]
- dropdown. Default is an empty NameValueCollection .
-
-
- The contents of this collection will override the default CSS classes
- available in the Apply CSS Class dropdown.
-
-
-
-
- Gets the collection containing the snippets to put in the Code Snippet
- dropdown.
-
-
- A NameValueCollection containing the snippets to put in the Code Snippet dropdown.
- Default is an empty NameValueCollection.
-
-
- The Code Snippet dropdown is a very convenient tool for inserting predefined
- chunks of HTML content like signatures, product description templates, custom
- tables, etc.
- The contents of this collection will override the default snippets available
- in the Code Snippet dropdown.
-
-
-
- Gets the collection containing the available languages for spellchecking.
-
- RadEditor has integrated support for the multi-language mode of RadSpell. When
- working with content in different languages you can select the proper spellchecking
- dictionary from a dropdown button on the RadEditor toolbar.
-
-
- A NameValueCollection containing the available languages for spellchecking.
- Default value is empty NameValueCollection.
-
-
- This example demonstrates how to enable spellchecking for English, French and German languages
- in RadEditor spellchecker.
-
- Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadEditor1.Languages.Add("en-US", "English");
- RadEditor1.Languages.Add("fr-FR", "French");
- RadEditor1.Languages.Add("de-DE", "German");
- End Sub
-
-
- private void Page_Load(object sender, EventArgs e)
- {
- RadEditor1.Languages.Add("en-US", "English");
- RadEditor1.Languages.Add("fr-FR", "French");
- RadEditor1.Languages.Add("de-DE", "German");
- }
-
- ///
-
-
-
- Gets or sets a string containing the path to the XML toolbar configuration file.
-
-
- This property is provided for backwards compatibility. Please, use either
- inline toolbar declaration or code-behind to configure the toolbars. To configure
- multiple RadEditor controls with the same settings you could use either Theme,
- UserControl with inline declaration, or CustomControl.
-
- Use "~" (tilde) as a substitution of the web-application's root
- directory.
- You can also provide this property with an absolute URL which returns a valid XML
- toolbar configuration file, e.g. http://MyServer/MyApplication/Tools/MyToolsFile.aspx
-
-
-
-
- Gets or sets a string containing the localization language for the RadEditor UI
-
-
-
-
- Gets or sets a string, containing the location of the content area CSS styles.
- You need to set this property only if you are using a custom skin.
-
- The content area CSS file.
-
-
-
- Gets or sets a string, containing the location of the CSS styles for table css style layout tool in the TableProperties dialogue.
-
- The content area CSS file.
-
-
-
- Gets or sets a value indicating where the editor will look for its .resx localization files.
- By default these files should be in the App_GlobalResources folder. However, if you cannot put
- the resource files in the default location or .resx files compilation is disabled for some reason
- (e.g. in a DotNetNuke environment), this property should be set to the location of the resource files.
-
-
- A relative path to the dialogs location. For example: "~/controls/RadEditorResources/".
-
-
- If specified, the LocalizationPath
- property will allow you to load the editor localization files from any location in the
- web application.
-
-
-
-
- Gets or sets the value indicating whether script tags will be allowed in the editor content.
- This property is now obsolete. Please use the ContentFilters property or the EnableFilter and DisableFilter methods
-
-
- The default value is false. This means that script tags will be removed from the content.
-
-
-
-
- Gets or sets the value indicating whether the RadEditor will auto-resize its height to match content height
-
-
- The default value is false.
-
-
-
-
- Gets or sets the value indicating whether the users will be able to resize the RadEditor control on the client
-
-
- The default value is true.
-
-
-
-
- Gets or sets the value indicating whether the RadEditor will insert a new line or
- a paragraph when the [Enter] key is pressed.
-
-
- true when the RadEditor will insert <br> tag when the
- [Enter] key is pressed; otherwise false. The default
- value is true.
-
-
- Note: this property is intended for use only in Internet Explorer.
- The gecko-based browsers always insert <BR> tags.
-
-
-
-
- Gets or sets the value indicating how the editor toolbar will be rendered and will act on the client
-
-
- Default Toolbars are rendered around the editor content area.
- Floating Toolbars are rendered in a moveable window.
- PageTop Toolbars appear on top of page when editor gets focus.
- ShowOnFocus Toolbars appear right above the editor when it focus.
-
-
-
- Several editors can simulate usage of the same toolbar if this property has the same value everywhere
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when editor is loaded on the client.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientLoad
- client-side event handler is called when editor is loaded on the client.
- Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientLoad property.
-
-
- <script type="text/javascript">
- function OnClientLoad(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when editor starts to load on the client.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientInit
- client-side event handler is called when editor starts to load on the client.
- Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientInit property.
-
-
- <script type="text/javascript">
- function OnClientInit(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when a dialog is closed, but before its value returned would be pasted into the editor.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientPasteHtml
- client-side event handler is called when a dialog is closed, but before its value returned would be pasted into the editor.
- Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientPasteHtml property.
-
-
- <script type="text/javascript">
- function OnClientPasteHtml(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when the content is submitted.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientPasteHtml
- client-side event handler is called when a dialog is closed, but before its value returned would be pasted into the editor.
- Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientSubmit property.
-
-
- <script type="text/javascript">
- function OnClientSubmit(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when the content is submitted.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientModeChange
- client-side event handler is called when the mode of the editor is changing..
- Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientModeChange property.
-
-
- <script type="text/javascript">
- function OnClientModeChange(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when selection inside editor content area changes
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientSelectionChange
- client-side event handler is called when selection inside editor content area changes.
- Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientSelectionChange property.
-
-
- <script type="text/javascript">
- function OnClientSelectionChange(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- an editor command starts executing.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientCommandExecuting
- client-side event handler is called before a command starts executing.
- Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientCommandExecuting property.
-
-
- <script type="text/javascript">
- function OnClientCommandExecuting(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after an editor command was executed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientCommandExecuted
- client-side event handler that is called
- when after an editor command was executed. Two parameters are passed to the handler:
-
- sender, the RadEditor object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientCommandExecuted property.
-
-
- <script type="text/javascript">
- function OnClientCommandExecuted(sender, args)
- {
- var editor = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets the height of the Web server control. The default height is 400 pixels.
-
-
-
-
- Gets or sets the width of the Web server control. The default width is 680 pixels.
-
-
-
-
- Gets or sets the width of the editor's toolbar (should be used when ToolbarMode != Default).
-
-
-
-
- Gets or sets the max length (in symbols) of the text inserted in the RadEditor. When the value is 0 the property is disabled.
-
-
-
-
- Gets or sets the max length (in symbols) of the HTML inserted in the RadEditor. When the value is 0 the property is disabled.
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded client scripts or not.
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed script files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
- Gets the text content of the RadEditor control without the HTML markup.
-
- The text displayed in the RadEditor without the HTML markup. The default is
- string.Empty.
-
-
-
- The text returned by this property contains no HTML markup. If only the HTML
- markup in the text is needed use the Html property.
-
-
- You can set the text content of the RadEditor by using the
- Html property or inline between its opening and closing
- tags. In this case setting the Html property in the code
- behind will override the inline content.
-
-
-
- For an example see the Html property.
-
-
-
-
- Gets or sets the value indicating which will be the available EditModes.
-
-
-
-
- Gets or sets the text content of the RadEditor control inlcuding the HTML
- markup. The Html property is deprecated in RadEditor.
- Use Content instead.
-
-
- The text content of the RadEditor control including the HTML markup. The default is
- string.Empty.
-
-
-
-
- Gets or sets the text content of the RadEditor control inlcuding the HTML
- markup.
-
-
- The text content of the RadEditor control including the HTML markup. The default is
- string.Empty.
-
-
-
- The text returned by this property contains HTML markup. If only the text is
- needed use the Text property.
-
- You can also set the text content of the RadEditor inline between the
- <Content></Content> tags. In this case setting this property
- in the code behind will override the inline content.
-
-
- This example demonstrates how to set the content of the RadEditor inline and the
- differences between the Content and Text
- <rade:RadEditor id="RadEditor1" runat="server"
- >
- <Content>
- Telerik RadEditor<br>
- the best <span style="COLOR: red">html editor</span> in the
- world
- </Content>
- </rade:RadEditor>
- <asp:button id="btnSave" runat="server" text="Submit"
- onclick="btnSave_Click" /><br />
- Content:<asp:label runat="server" id="LabelContent"></asp:label><br
- />
- Text:<asp:label runat="server" id="LabelText"></asp:label><br
- />
-
-
- Private Sub btnSave_Click(sender As Object, e As System.EventArgs)
- 'HtmlEncode the content of the editor to display the HTML tags
- LabelContent.Text = Server.HtmlEncode(RadEditor1.Content);
- LabelText.Text = Server.HtmlEncode(RadEditor1.Text);
- End Sub
-
-
- private void btnSave_Click(object sender, System.EventArgs e)
- {
- //HtmlEncode the content of the editor to display the HTML tags
- LabelContent.Text = Server.HtmlEncode(RadEditor1.Content);
- LabelText.Text = Server.HtmlEncode(RadEditor1.Text);
- }
-
-
-
-
-
- Contains the configuration of the ImageManager dialog.
-
-
- An ImageManagerDialogConfiguration
- instance, containing the configuration of the ImageManager dialog
-
-
-
-
- Contains the configuration of the DocumentManager dialog.
-
-
- An FileManagerDialogConfiguration
- instance, containing the configuration of the DocumentManager dialog
-
-
-
-
- Contains the configuration of the FlashManager dialog.
-
-
- An FileManagerDialogConfiguration
- instance, containing the configuration of the FlashManager dialog
-
-
-
-
- Contains the configuration of the SilverlightManager dialog.
-
-
- An FileManagerDialogConfiguration
- instance, containing the configuration of the SilverlightManager dialog
-
-
-
-
- Contains the configuration of the MediaManager dialog.
-
-
- An FileManagerDialogConfiguration
- instance, containing the configuration of the MediaManager dialog
-
-
-
-
- Contains the configuration of the TemplateManager dialog.
-
-
- An FileManagerDialogConfiguration
- instance, containing the configuration of the TemplateManager dialog
-
-
-
-
- Contains the configuration of the spell checker.
-
-
-
-
- Gets the collection of the dialog definitions (configurations) of the editor.
-
-
- A DialogDefinitionDictionary, specifying the definitions of the dialogs of the editor.
-
-
-
-
- This property is obsolete. Please, use the StripFormattingOptions property instead.
-
-
- The default value is EditorStripFormattingOptions.None.
-
-
-
-
- Gets or sets the value indicating how the editor should clear the HTML formatting
- when the user pastes data into the content area.
-
-
- The default value is EditorStripFormattingOptions.None.
-
-
-
- EditorStripFormattingOptions
- enum members
-
-
- Member
- Description
-
-
- None
- Doesn't strip anything, asks a question when MS Word
- formatting was detected.
-
-
- NoneSupressCleanMessage
- Doesn't strip anything and does not ask a
- question.
-
-
- MSWord
- Strips only MSWord related attributes and
- tags.
-
-
- MSWordNoFonts
- Strips the MSWord related attributes and tags and font
- tags.
-
-
- MSWordRemoveAll
- Strips MSWord related attributes and tags, font tags and
- font size attributes.
-
-
- Css
- Removes style attributes.
-
-
- Font
- Removes Font tags.
-
-
- Span
- Clears Span tags.
-
-
- AllExceptNewLines
- Clears all tags except "br" and new lines (\n) on paste.
-
-
- All
- Remove all HTML formatting.
-
-
-
- Note: In Gecko-based browsers you will see the mandatory
- dialog box where you need to paste the content.
-
-
-
-
- Gets or sets the URL which the AJAX call will be made to. Check the help for more information.
-
-
-
-
- Gets or sets the location of a CSS file, that will be added in the dialog window. If you need to include
- more than one file, use the CSS @import url(); rule to add the other files from the first.
- This property is needed if you are using a custom skin. It allows you to include your custom skin
- CSS in the dialogs, which are separate from the main page.
-
-
-
-
- Gets or sets the location of a JavaScript file, that will be added in the dialog window. If you need to include
- more than one file, you will need to combine the scripts into one first.
- This property is needed if want to override some of the default functionality without loading the dialog
- from an external ascx file.
-
-
-
-
- A read-only property that returns the DialogOpener instance used in the editor control.
-
-
-
-
- Gets or sets a value indicating which content filters will be active when the editor is loaded in the browser.
-
-
- The default value is EditorFilters.DefaultFilters.
-
-
- EditorFilters enum members
-
-
- Member
- Description
-
-
- RemoveScripts
- This filter removes script tags from the editor content. Disable the filter if you want to insert script tags in the content.
-
-
- MakeUrlsAbsolute
- This filter makes all URLs in the editor content absolute (e.g. "http://server/page.html" instead of "page.html"). This filter is DISABLED by default.
-
-
- FixUlBoldItalic
- This filter changes the deprecated u tag to a span with CSS style.
-
-
- IECleanAnchors
- Internet Explorer only - This filter removes the current page url from all anchor(#) links to the same page.
-
-
- FixEnclosingP
- This filter removes a parent paragraph tag if the whole content is inside it.
-
-
- MozEmStrong
- This filter changes b to strong and i to em in Mozilla browsers.
-
-
- ConvertFontToSpan
- This filter changes deprecated font tags to compliant span tags.
-
-
- ConvertToXhtml
- This filter converts the HTML from the editor content area to XHTML.
-
-
- IndentHTMLContent
- This filter indents the HTML content so it is more readable when you view the code.
-
-
- OptimizeSpans
- This filter tries to decrease the number of nested spans in the editor content.
-
-
- DefaultFilters
- The default editor behavior. All content filters except MakeUrlsAbsolute are activated.
-
-
-
-
-
-
-
- Gets or sets a value indicating where the editor will look for its dialogs.
-
-
- A relative path to the dialogs location. For example: "~/controls/RadEditorDialogs/".
-
-
- If specified, the ExternalDialogsPath
- property will allow you to customize and load the editor dialogs from normal ASCX files.
-
-
-
-
- This event is raised before a file is deleted using the current content provider.
- The file delete will be canceled if you return false from the event handler.
-
-
-
-
- This event is raised before a file is deleted using the current content provider.
- The file delete will be canceled if you return false from the event handler.
-
-
-
-
- This event is raised before the file is stored using the current content provider.
- The file upload will be canceled if you return false from the event handler.
-
-
-
-
- Occurs when the content of the RadEditor changes between posts to the server.
-
-
-
-
- A tool which will be rendered as a button
-
-
-
-
- A tool which will be rendered as a dropdown
-
-
-
-
- A tool which will be rendered as a split button
-
-
-
-
- A tool which will be rendered as a separator
-
-
-
-
- A tool which will be rendered as a toolstrip
-
-
-
-
- Represents logical group of EditorTool objects. The default ToolAdapter will
- render the EditorToolGroup object as a toolbar.
-
-
-
-
-
-
-
-
-
-
-
-
- Gets all tools inside the group.
-
-
-
-
- Finds the tool with the given name.
-
-
-
-
- Determines whether the group a tool with the specified name.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets the custom attributes which will be serialized on the client.
-
-
-
-
- Gets or sets a string which will be used by the ToolAdapter to associate
- the group with the adapter's virtual structure. In the default adapter this
- is the name of the docking zone where the toolbar should be placed.
-
-
-
-
- Gets the children of the EditorToolGroup.
-
-
-
-
- State managed collection of EditorToolGroup objects
-
-
-
-
- Represents a single RadEditor tool.
-
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- Initializes a new instance of the class.
-
- The name of the tool.
-
-
-
- Initializes a new instance of the class.
-
- The name of the tool.
- The shortcut for the tool.
-
-
-
- Throws an exception if the EditorTool has no name.
-
-
-
-
- Gets or sets a value indicating whether this is enabled.
-
- true if enabled; otherwise, false.
-
-
-
- Gets or sets the name. It will be used by RadEditor to find
- the command which should be executed when the user clicks this tool.
-
- The tool name.
-
-
-
- Gets or sets the title of the . The default ToolAdapter will
- render the value of this property as a tooltip or static text near the
- tool icon.
-
- The text.
-
-
-
- Gets or sets the keyboard shortcut which will invoke the associated
- RadEditor command.
-
-
-
-
- Gets or sets a value indicating whether the tool icon should be displayed.
-
- true if the tool icon should be displayed; otherwise, false.
-
-
-
- Gets or sets a value indicating whether the tool text should be displayed.
-
- true if the tool text should be displayed; otherwise, false.
-
-
-
- Gets or sets the type of the tool - by default it is a button
-
- The type of the tool on the client.
-
-
-
- Summary description for DisplayFormatPosition.
-
-
-
-
- Fired whenever the value of any enumeration mask part has changed.
-
-
- Note this event is effective only for the RadMaskedTextBox control.
-
-
-
-
- Fired whenever the user increases the value of any enumeration or numeric range mask part of RadMaskedTextBox
- (with either keyboard arrow keys or mouse wheel).
-
-
- Note this event is effective only for the RadMaskedTextBox control.
-
-
-
-
- Fired whenever the user decreases the value of any enumeration or numeric range mask part of RadMaskedTextBox
- (with either keyboard arrow keys or mouse wheel).
-
-
- Note this event is effective only for the RadMaskedTextBox control.
-
-
-
- Represents a single character, digit only mask part.
-
- This example demonstrates how to add a DigitMaskPart object in the
- MaskParts property of RadMaskedTextBox.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- DigitMaskPart digitPart = new DigitMaskPart();
- RadMaskedTextBox1.MaskParts.Add(digitPart);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim digitPart As New DigitMaskPart()
- RadMaskedTextBox1.MaskParts.Add(digitPart)
- End Sub
-
-
-
-
- The abstract base class of all mask parts.
- This class is not intended to be used directly.
-
-
-
-
-
-
-
- Returns the friendly name of the part.
-
-
-
-
-
-
-
-
- Represents a MaskPart object which accepts only a predefined set of
- options.
-
-
- This example demonstrates how to add an EnumerationMaskPart object
- in the MaskParts property of RadMaskedTextBox.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- EnumerationMaskPart enumPart = new EnumerationMaskPart();
- enumPart.Items.Add("Mon");
- enumPart.Items.Add("Two");
- enumPart.Items.Add("Wed");
- enumPart.Items.Add("Thu");
- enumPart.Items.Add("Fri");
- enumPart.Items.Add("Sat");
- enumPart.Items.Add("Sun");
-
- RadMaskedTextBox1.MaskParts.Add(enumPart);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim enumPart As New EnumerationMaskPart
- enumPart.Items.Add("Mon")
- enumPart.Items.Add("Two")
- enumPart.Items.Add("Wed")
- enumPart.Items.Add("Thu")
- enumPart.Items.Add("Fri")
- enumPart.Items.Add("Sat")
- enumPart.Items.Add("Sun")
-
- RadMaskedTextBox1.MaskParts.Add(enumPart)
- End Sub
-
-
-
-
- Returns the friendly name of the part.
-
-
-
- Gets the options collection of the part.
-
-
-
-
-
-
-
-
- Represents a single character MaskPart object which accepting any
- character.
-
-
- This example demonstrates how to add a FreeMaskPart object in the
- MaskParts property of RadMaskedTextBox.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- FreeMaskPart freePart = new FreeMaskPart();
- RadMaskedTextBox1.MaskParts.Add(freePart);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim fixedPart As New FreeMaskPart()
- RadMaskedTextBox1.MaskParts.Add(fixedPart)
- End Sub
-
-
-
-
-
- Returns the friendly name of the part.
-
-
-
- Represents a multi character MaskPart whose content cannot be modified.
-
- This example demonstrates how to add a LiteralMaskPart object in
- the MaskParts property of RadMaskedTextBox.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- LiteralMaskPart literalPart = new LiteralMaskPart();
- literalPart.Text = "(";
- RadMaskedTextBox1.MaskParts.Add(literalPart);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim literalPart As New LiteralMaskPart()
- RadMaskedTextBox1.MaskParts.Add(literalPart)
- End Sub
-
-
-
-
-
- Returns the friendly name of the part.
-
-
-
-
-
-
-
- Gets or sets the string that the LiteralMaskPart will render.
-
-
-
- Represents a single character MaskPart. The character is converted to lower upon
- input.
-
-
- This example demonstrates how to add a LowerMaskPart object in the
- MaskParts property of RadMaskedTextBox.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- LowerMaskPart lowerPart = new LowerMaskPart();
- RadMaskedTextBox1.MaskParts.Add(lowerPart);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim lowerPart As New LowerMaskPart()
- RadMaskedTextBox1.MaskParts.Add(lowerPart)
- End Sub
-
-
-
-
-
- Returns the friendly name of the part.
-
-
-
-
-
-
-
- Represents the collection of mask parts in a RadMaskedTextBox.
-
-
-
- Appends the specified MaskPart to
- the end of the collection.
-
-
- The MaskPart to append to the
- collection.
-
-
-
-
- Inserts the specified MaskPart in
- the collection at the specified index location.
-
-
- The location in the collection to insert the
- MaskPart.
-
-
- The MaskPart to add to the
- collection.
-
-
-
- Determines whether the collection contains the specified item
-
- true if the collection contains the specified
- MaskPart; otherwise
- false.
-
-
- The MaskPart to search for in the
- collection.
-
-
-
-
-
- Removes the specified MaskPart
- from the collection.
-
-
-
- The MaskPart to remove from the
- collection.
-
-
-
-
- Determines the index value that represents the position of the specified
- MaskPart in the collection.
-
-
- The zero-based index position of the specified
- MaskPart in the collection.
-
-
- A MaskPart to search for in the
- collection.
-
-
-
-
- Gets or sets the RadMaskedInputControl, which uses the
- collection.
-
-
-
-
- Gets a MaskPart at the specified
- index in the collection.
-
-
- Use this indexer to get a MaskPart
- from the
- MaskPartCollection at the
- specified index, using array notation.
-
-
- The zero-based index of the MaskPart
- to retrieve from the collection.
-
-
-
- Represents a MaskPart which accepts numbers in a specified range.
-
- This example demonstrates how to add a NumericRangeMaskPart object
- in the MaskParts collection of RadMaskedTextBox.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- NumericRangeMaskPart rangePart = new NumericRangeMaskPart();
- rangePart.LowerLimit = 0;
- rangePart.UpperLimit = 255;
- RadMaskedTextBox1.MaskParts.Add(rangePart);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim rangePart As New NumericRangeMaskPart()
- rangePart.LowerLimit = 0
- rangePart.UpperLimit = 255
- RadMaskedTextBox1.MaskParts.Add(rangePart)
- End Sub
-
-
-
-
- Returns the friendly name of the part.
-
-
-
-
-
-
- Gets or sets the smallest possible value the part can accept.
-
- An integer representing the smallest acceptable number that the
- NumericRangeMaskPart can accept. The default value is 0.
-
-
-
- Gets or sets the largest possible value the part can accept.
-
- An integer representing the largest acceptable number that the
- NumericRangeMaskPart can accept. The default value is 0.
-
-
-
-
- Represents a single character MaskPart. The character is converted to upper upon
- input. .
-
-
- This example demonstrates how to add an UpperMaskPart object in
- the MaskParts collection of RadMaskedTextBox.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- UpperMaskPart upperPart = new UpperMaskPart();
- RadMaskedTextBox1.MaskParts.Add(upperPart);
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- Dim upperPart As New UpperMaskPart()
- RadMaskedTextBox1.MaskParts.Add(upperPart)
- End Sub
-
-
-
-
- Returns the friendly name of the part.
-
-
-
- Numeric range alignment options
-
-
-
-
- The numbers are aligned left
-
-
-
-
- The numbers are aligned right
-
-
-
-
- Telerik RadMaskedTextBox
-
-
-
- Gets or sets the string to use as the decimal separator in values.
- The string to use as the decimal separator in values.
- The property is being set to an empty string.
- The property is being set to null.
-
-
- Gets the native decimal separator of the control's culture.
-
-
- Gets or sets the number of decimal places to use in numeric values
- The number of decimal places to use in values.
- The property is being set to a value that is less than 0 or greater than 99.
-
-
-
- Gets or sets the number of digits in each group to the left of the decimal in
- values.
-
- The number of digits in each group to the left of the decimal in values.
- The property is being set to null.
-
-
-
- Gets or sets the string that separates groups of digits to the left of the
- decimal in values.
-
-
- The string that separates groups of digits to the left of the decimal in
- values.
-
- The property is being set to null.
-
-
- Gets or sets the format pattern for negative values.
- The format pattern for negative percent values.
- The property is being set to a value that is less than 0 or greater than 11.
-
-
- Gets or sets the format pattern for positive values.
- The format pattern for positive percent values. The
- The property is being set to a value that is less than 0 or greater than 3.
-
-
-
- Telerik RadNumericTextBox
-
-
-
-
- Gets the style properties for RadInput when when the text is
- negative.
-
-
- A Telerik.WebControls.TextBoxStyle object that represents the style properties
- for RadInput control. The default value is an empty TextBoxStyle object.
-
-
- The following code example demonstrates how to set NegativeStyle
- property:
- [C#]
-
- </%@ Page Language="C#" /%> </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
- Use this property to provide a custom style for the negative state of
- RadInput control. Common style attributes that can be adjusted include
- foreground color, background color, font, and alignment within the RadInput.
- Providing a different style enhances the appearance of the RadInput
- control.
- Negative style properties in the RadInput control are inherited from one
- style property to another through a hierarchy. For example, if you specify a red
- font for the EnabledStyle property, all other style properties in the RadInput
- control will also have a red font. This allows you to provide a common appearance
- for the control by setting a single style property. You can override the inherited
- style settings for an item style property that is higher in the hierarchy by
- setting its style properties. For example, you can specify a blue font for the
- NegativeStyle property, overriding the red font specified in the EnabledStyle
- property.
- To specify a custom style, place the <NegativeStyle> tags between the
- opening and closing tags of the RadInput control. You can then list the style
- attributes within the opening <NegativeStyle> tag.
-
-
-
- Gets or sets the value of the RadInput control.
-
- Use the Text property to specify or determine the text displayed in the
- RadInput control. To limit the number of characters accepted by the control, set
- the MaxLength property. If you want to prevent the text from being modified, set
- the ReadOnly property.
- The value of this property, when set, can be saved automatically to a
- resource file by using a designer tool.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
- null if the Text property is Empty.The Value property are Nullable Double type. A
- nullable type can represent the normal range of values for its underlying value type,
- plus an additional null value. For example, a Nullable<Double>, pronounced
- "Nullable of Double," can be assigned any value from -2^46 (-70368744177664) to
- 2^46 (70368744177664), or it can be assigned the null value.
-
-
-
-
- Gets or sets the date content of RadNumericTextBox in a database friendly
- way.
-
- An object that represents the Text property. The default value is null.
-
- This property behaves exactly like the Value property. The only difference is
- that it will not throw an exception if the new value is not double object (or null). If
- you assign null to the control you will see blank RadInput.
-
-
- The following example demonstrates how to bind the RadNumericTextBox:
- [C#]
-
- </%@ Page Language="C#" /%> </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> <script runat="server"> Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load Dim table As System.Data.DataTable = New System.Data.DataTable table.Columns.Add("num") Dim row As System.Data.DataRow = table.NewRow row("num") = CType(12.56,Double) table.Rows.Add(row) row = table.NewRow row("num") = CType(12,Integer) table.Rows.Add(row) row = table.NewRow row("num") = DBNull.Value table.Rows.Add(row) row = table.NewRow row("num") = "33" table.Rows.Add(row) row = table.NewRow table.Rows.Add(row) Repeater1.DataSource = table Repeater1.DataBind End Sub </script> </head> <body> <form id="form1" runat="server"> <asp:Repeater runat="server" ID="Repeater1"> <ItemTemplate> <radI:RadNumericTextBox DbValue='</%# Bind("num") /%>' ID="RadNumericTextBox1" runat="server"> </radI:RadNumericTextBox> </ItemTemplate> </asp:Repeater> </form> </body> </html>
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Gets or sets a value indicating whether the button is displayed in the
- RadInput control.
-
-
- true if the button is displayed; otherwise, false. The default value is true,
- however this property is only examined when the ButtonTemplate property is not a null
- reference (Nothing in Visual Basic).
-
-
- Use the ShowButton property to specify whether the button is displayed in the
- RadInput control.
- The contents of the button are controlled by the ButtonTemplate
- property.
-
-
- The following code example demonstrates how to use the ShowButton property to
- display the button in the RadInput control.
- [C#]
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Type of object that is used to wrap the DbValue property.
-
-
- That property is designed to be used when this control is
- embedded into grid or other data-bound control.
- Default value is set to the Double.
-
-
- Default value is set to the Double.
-
-
- Gets or sets the culture used by RadNumericTextBox to format the numburs.
-
- A CultureInfo object that represents the current culture used. The default value
- is System.Threading.Thread.CurrentThread.CurrentUICulture.
-
-
- The following example demonstrates how to use the Culture property.
-
- private void Page_Load(object sender, System.EventArgs e)
- {
- RadNumericTextBox.Culture = new CultureInfo("en-US");
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- RadNumericTextBox1.Culture = New CultureInfo("en-US")
- End Sub
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets or sets the largest possible value of a RadNumericTextBox.
- The default value is positive 2^46.
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets or sets the smallest possible value of a RadNumericTextBox.
-
- The default value is negative -2^46.
-
-
-
- Gets or sets whether the RadNumericTextBox should autocorrect out of range values to valid values or leave them visible to the user and apply its InvalidStyle. If the InvalidStyle is applied, the control will have no value.
-
- The default value is true
-
-
- Gets or sets the numeric type of the RadNumericTextBox.
- One of the NumericType enumeration values. The default is Number.
-
- Use the Type property to determine the numeric type that the RadNumericTextBox
- represents. The Type property is represented by one of the NumericType enumeration
- values.
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets control that contains the up button of RadInput control
- The ShowButton or ShowSpinButton properties must be set to true
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets control that contains the up button of RadInput control
- The ShowButton or ShowSpinButton properties must be set to true
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Summary description for AutoPostBackControl.
-
-
-
-
- Telerik RadTextBox
-
-
-
-
- Gets or sets the behavior mode (single-line, multiline, or password) of the
- RadTextBox control.
-
-
- One of the RadInputTextBoxMode enumeration values. The default value is
- SingleLine.
-
-
- Use the TextMode property to specify whether a RadTextBox control is
- displayed as a single-line, multiline, or password text box.
- When the RadTextBox control is in multiline mode, you can control the number
- of rows displayed by setting the Rows property. You can also specify whether the
- text should wrap by setting the Wrap property.
- If the RadTextBox control is in password mode, all characters entered in the
- control are masked.
- This property cannot be set by themes or style sheet themes
-
- The specified mode is not one of the TextBoxMode enumeration values.
-
- The following code example demonstrates how to use the RadTextMode property to
- specify a multiline text box. This example has a text box that accepts user input,
- which is a potential security threat. By default, ASP.NET Web pages validate that
- user input does not include script or HTML elements.
-
- <%@ Page Language="VB" AutoEventWireup="True" %>
-
- <%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html>
- <head>
- <title>MultiLine RadTextBox Example </title>
-
- <script runat="server">
-
- Protected Sub SubmitButton_Click(sender As Object, e As EventArgs )
-
- Message.Text = "Thank you for your comment: <br />" + Comment.Text
-
- End Sub
-
- Protected Sub Check_Change(sender As Object, e As EventArgs )
-
- Comment.Wrap = WrapCheckBox.Checked
- Comment.ReadOnly = ReadOnlyCheckBox.Checked
-
- End Sub
-
- </script>
-
- </head>
- <body>
- <form id="form1" runat="server">
- <h3>
- MultiLine RadTextBox Example
- </h3>
- Please enter a comment and click the submit button.
- <br />
- <br />
- <radI:RadTextBox ID="Comment" TextMode="MultiLine" Columns="50" Rows="5" runat="server" />
- <br />
- <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Comment"
- ErrorMessage="Please enter a comment.<br />" Display="Dynamic" runat="server" />
- <asp:CheckBox ID="WrapCheckBox" Text="Wrap Text" Checked="True" AutoPostBack="True"
- OnCheckedChanged="Check_Change" runat="server" />
-
- <asp:CheckBox ID="ReadOnlyCheckBox" Text="ReadOnly" Checked="False" AutoPostBack="True"
- OnCheckedChanged="Check_Change" runat="server" />
-
- <asp:Button ID="SubmitButton" Text="Submit" OnClick="SubmitButton_Click" runat="server" />
- <hr />
- <asp:Label ID="Message" runat="server" />
- </form>
- </body>
- </html>
-
-
- <%@ Page Language="C#" AutoEventWireup="True" %>
-
- <%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" %>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html>
- <head>
- <title>MultiLine RadTextBox Example </title>
-
- <script runat="server">
-
- protected void SubmitButton_Click(Object sender, EventArgs e)
- {
-
- Message.Text = "Thank you for your comment: <br />" + Comment.Text;
-
- }
-
- protected void Check_Change(Object sender, EventArgs e)
- {
-
- Comment.Wrap = WrapCheckBox.Checked;
- Comment.ReadOnly = ReadOnlyCheckBox.Checked;
-
- }
-
- </script>
-
- </head>
- <body>
- <form id="form1" runat="server">
- <h3>
- MultiLine RadTextBox Example
- </h3>
- Please enter a comment and click the submit button.
- <br />
- <br />
- <radI:RadTextBox ID="Comment" TextMode="MultiLine" Columns="50" Rows="5" runat="server" />
- <br />
- <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Comment"
- ErrorMessage="Please enter a comment.<br />" Display="Dynamic" runat="server" />
- <asp:CheckBox ID="WrapCheckBox" Text="Wrap Text" Checked="True" AutoPostBack="True"
- OnCheckedChanged="Check_Change" runat="server" />
-
- <asp:CheckBox ID="ReadOnlyCheckBox" Text="ReadOnly" Checked="False" AutoPostBack="True"
- OnCheckedChanged="Check_Change" runat="server" />
-
- <asp:Button ID="SubmitButton" Text="Submit" OnClick="SubmitButton_Click" runat="server" />
- <hr />
- <asp:Label ID="Message" runat="server" />
- </form>
- </body>
- </html>
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Gets or sets a value that indicates the AutoComplete behavior of the RadTextBox
- control
-
-
- One of the System.Web.UI.WebControls.AutoCompleteType enumeration values,
- indicating the AutoComplete behavior for the RadTextBox control. The default value is
- None.
-
- The selected value is not one of the System.Web.UI.WebControls.AutoCompleteType enumeration values.
-
- To assist with data entry, Microsoft Internet Explorer 5 and later and
- Netscape support a feature called AutoComplete. AutoComplete monitors a RadTextBox
- and creates a list of values entered by the user. When the user returns to the
- RadTextBox at a later time, the list is displayed. Instead of retyping a previously
- entered value, the user can simply select the value from this list. Use the
- AutoCompleteType property to control the behavior of the AutoComplete feature for a
- RadTextBox control. The System.Web.UI.WebControls.AutoCompleteType enumeration is
- used to represent the values that you can apply to the AutoCompleteType property.
- Not all browsers support the AutoComplete feature. Check with your browser to
- determine compatibility.
- By default, the AutoCompleteType property for a RadTextBox control is set to
- AutoCompleteType.None. With this setting, the RadTextBox control shares the list
- with other RadTextBox controls with the same ID property across different pages.
- You can also share a list between RadTextBox controls based on a category, instead
- of an ID property. When you set the AutoCompleteType property to one of the
- category values (such as AutoCompleteType.FirstName, AutoCompleteType.LastName, and
- so on), all RadTextBox controls with the same category share the same list. You can
- disable the AutoComplete feature for a RadTextBox control by setting the
- AutoCompleteType property to AutoCompleteType.Disabled.
- Refer to your browser documentation for details on configuring and enabling
- the AutoComplete feature. For example, to enable the AutoComplete feature in
- Internet Explorer version 5 or later, select Internet Options from the Tools menu,
- and then select the Content tab. Click the AutoComplete button to view and modify
- the various browser options for the AutoComplete feature.
- This property cannot be set by themes or style sheet themes.
-
-
- The following code example demonstrates how to use the AutoCompleteType
- enumeration to specify the AutoComplete category for a RadTextBox control. This
- example has a text box that accepts user input, which is a potential security
- threat. By default, ASP.NET Web pages validate that user input does not include
- script or HTML elements.
- [C#]
-
- </%@ Page Language="C#" /%>
- </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html> <head id="Head1" runat="server"> <title>AutoCompleteType example</title> </head> <body>
- <form id="form1" runat="server"> <!-- You need to enable the AutoComplete feature on -->
- <!-- a browser that supports it (such as Internet --> <!-- Explorer 5.0 and later) for this sample to -->
- <!-- work. The AutoComplete lists are created after --> <!-- the Submit button is clicked. -->
- <h3> AutoCompleteType example</h3> Enter values in the text boxes and click the Submit <br />
- button. <br /> <br /> <!-- The following TextBox controls have different -->
- <!-- categories assigned to their AutoCompleteType --> <!-- properties. -->
- First Name:<br /> <radI:RadTextBox ID="FirstNameTextBox" AutoCompleteType="FirstName" runat="server" /> <br />
- Last Name:<br /> <radI:RadTextBox ID="LastNameTextBox" AutoCompleteType="LastName" runat="server" /> <br />
- Email:<br /> <radI:RadTextBox ID="EmailTextBox" AutoCompleteType="Email" runat="server" /> <br />
- <!-- The following TextBox controls have the same --> <!-- categories assigned to their AutoCompleteType -->
- <!-- properties. They share the same AutoComplete --> <!-- list. --> Phone Line #1:<br />
- <radI:RadTextBox ID="Phone1TextBox" AutoCompleteType="HomePhone" runat="server" /> <br /> Phone Line #2:<br />
- <radI:RadTextBox ID="Phone2TextBox" AutoCompleteType="HomePhone" runat="server" /> <br />
- <!-- The following TextBox control has its --> <!-- AutoCompleteType property set to -->
- <!-- AutoCompleteType.None. All TextBox controls -->
- <!-- with the same ID across different pages share --> <!-- the same AutoComplete list. --> Category:<br />
- <radI:RadTextBox ID="CategoryTextBox" AutoCompleteType="None" runat="server" /> <br /> <!-- The following TextBox control has the -->
- <!-- AutoComplete feature disabled. --> Comments:<br /> <radI:RadTextBox ID="CommentsTextBox" AutoCompleteType="Disabled" runat="server" />
- <br /> <br /> <br /> <asp:Button ID="SubmitButton" Text="Submit" runat="Server" /> </form> </body> </html>
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head id="Head1" runat="server">
- <title>AutoCompleteType example</title> </head> <body> <form id="form1" runat="server"> <!-- You need to enable the AutoComplete feature on -->
- <!-- a browser that supports it (such as Internet --> <!-- Explorer 5.0 and later) for this sample to --> <!-- work. The AutoComplete lists are created after -->
- <!-- the Submit button is clicked. --> <h3> AutoCompleteType example</h3> Enter values in the text boxes and click the Submit <br />
- button. <br /> <br /> <!-- The following TextBox controls have different --> <!-- categories assigned to their AutoCompleteType -->
- <!-- properties. --> First Name:<br /> <radI:RadTextBox ID="FirstNameTextBox" AutoCompleteType="FirstName" runat="server" /> <br />
- Last Name:<br /> <radI:RadTextBox ID="LastNameTextBox" AutoCompleteType="LastName" runat="server" /> <br /> Email:<br />
- <radI:RadTextBox ID="EmailTextBox" AutoCompleteType="Email" runat="server" /> <br /> <!-- The following TextBox controls have the same -->
- <!-- categories assigned to their AutoCompleteType --> <!-- properties. They share the same AutoComplete --> <!-- list. --> Phone Line #1:<br />
- <radI:RadTextBox ID="Phone1TextBox" AutoCompleteType="HomePhone" runat="server" /> <br /> Phone Line #2:<br /> <radI:RadTextBox ID="Phone2TextBox" AutoCompleteType="HomePhone" runat="server" />
- <br /> <!-- The following TextBox control has its --> <!-- AutoCompleteType property set to --> <!-- AutoCompleteType.None. All TextBox controls --> <!-- with the same ID across different pages share -->
- <!-- the same AutoComplete list. --> Category:<br /> <radI:RadTextBox ID="CategoryTextBox" AutoCompleteType="None" runat="server" /> <br /> <!-- The following TextBox control has the -->
- <!-- AutoComplete feature disabled. --> Comments:<br /> <radI:RadTextBox ID="CommentsTextBox" AutoCompleteType="Disabled" runat="server" /> <br /> <br /> <br /> <asp:Button ID="SubmitButton" Text="Submit" runat="Server" /> </form> </body> </html>
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0
-
-
-
- Gets or sets the number of rows displayed in a multiline RadTextBox.
-
- The number of rows in a multiline RadTextBox. The default is 0, which displays a
- two-line text box.
-
-
- Use the Rows property to specify the number of rows displayed in a multiline
- RadTextBox. This property is applicable only when the TextMode property is set to
- MultiLine. This property cannot be set by themes or style sheet themes. This example
- has a text box that accepts user input, which is a potential security threat. By
- default, ASP.NET Web pages validate that user input does not include script or HTML
- elements.
-
-
- The following code example demonstrates how to use the Rows property to
- specify a height of 5 rows for a multiline RadTextBox control.
- [C#]
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <title>MultiLine RadTextBox Example </title>
<script runat="server">
Protected Sub SubmitButton_Click(sender As Object, e As EventArgs )
- Message.Text = "Thank you for your comment: <br />" + Comment.Text
End Sub
Protected Sub Check_Change(sender As Object, e As EventArgs )
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
- Gets or sets the display width of the RadTextBox in characters.
-
- The display width, in characters, of the RadTextBox. The default is 0, which
- indicates that the property is not set.
-
- The specified width is less than 0.
-
- The following code example demonstrates how to use the Columns property to
- specify a width of 2 characters for the RadTextBox control. This example has a text
- box that accepts user input, which is a potential security threat. By default,
- ASP.NET Web pages validate that user input does not include script or HTML
- elements.
- [C#]
-
- </%@ Page Language="C#" AutoEventWireup="True" /%>
- </%@ Register Assembly="RadInput.Net2" Namespace="Telerik.WebControls" TagPrefix="radI" /%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <title>RadTextBox Example </title>
- <script runat="server">
- protected void AddButton_Click(Object sender, EventArgs e) { int Answer;
- Answer = Convert.ToInt32(Value1.Text) + Convert.ToInt32(Value2.Text);
- AnswerMessage.Text = Answer.ToString();
- }
- </script>
- </head> <body> <form id="form1" runat="server"> <h3> RadTextBox Example </h3>
- <table> <tr> <td colspan="5"> Enter integer values into the text boxes. <br />
- Click the Add button to add the two values. <br /> Click the Reset button to reset the text boxes. </td> </tr> <tr> <td colspan="5">
- </td> </tr> <tr align="center"> <td> <radI:RadTextBox ID="Value1" Columns="2" MaxLength="3" Text="1" runat="server" /> </td>
- <td> + </td> <td> <radI:RadTextBox ID="Value2" Columns="2" MaxLength="3" Text="1" runat="server" /> </td> <td> = </td>
- <td> <asp:Label ID="AnswerMessage" runat="server" /> </td> </tr> <tr> <td colspan="2"> <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Value1"
- ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" /> <asp:RangeValidator ID="Value1RangeValidator" ControlToValidate="Value1" Type="Integer" MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />"
- Display="Dynamic" runat="server" /> </td> <td colspan="2"> <asp:RequiredFieldValidator ID="Value2RequiredValidator" ControlToValidate="Value2" ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" />
- <asp:RangeValidator ID="Value2RangeValidator" ControlToValidate="Value2" Type="Integer" MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />" Display="Dynamic" runat="server" /> </td>
- <td>   </td> </tr> <tr align="center"> <td colspan="4"> <asp:Button ID="AddButton" Text="Add" OnClick="AddButton_Click" runat="server" /> </td> <td>
- </td> </tr> </table> </form> </body> </html>
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head>
- <title>TextBox Example </title>
<script runat="server">
Protected Sub AddButton_Click(sender As Object, e As EventArgs)
</head> <body> <form id="form1" runat="server"> <h3> RadTextBox Example </h3> <table> <tr> <td colspan="5"> Enter integer values into the text boxes.
- <br /> Click the Add button to add the two values. <br /> Click the Reset button to reset the text boxes. </td> </tr> <tr> <td colspan="5">
</td>
- </tr> <tr align="center"> <td> <radI:RadTextBox ID="Value1" Columns="2" MaxLength="3" Text="1" runat="server" /> </td> <td> + </td> <td>
- <radI:RadTextBox ID="Value2" Columns="2" MaxLength="3" Text="1" runat="server" /> </td> <td> = </td> <td> <asp:Label ID="AnswerMessage" runat="server" /> </td>
- </tr> <tr> <td colspan="2"> <asp:RequiredFieldValidator ID="Value1RequiredValidator" ControlToValidate="Value1" ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" />
- <asp:RangeValidator ID="Value1RangeValidator" ControlToValidate="Value1" Type="Integer" MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />" Display="Dynamic" runat="server" /> </td>
- <td colspan="2"> <asp:RequiredFieldValidator ID="Value2RequiredValidator" ControlToValidate="Value2" ErrorMessage="Please enter a value.<br />" Display="Dynamic" runat="server" /> <asp:RangeValidator ID="Value2RangeValidator" ControlToValidate="Value2" Type="Integer"
- MinimumValue="1" MaximumValue="100" ErrorMessage="Please enter an integer <br /> between than 1 and 100.<br />" Display="Dynamic" runat="server" /> </td> <td>   </td> </tr>
- <tr align="center"> <td colspan="4"> <asp:Button ID="AddButton" Text="Add" OnClick="AddButton_Click" runat="server" /> </td> <td>
</td> </tr> </table> </form> </body> </html>
-
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
-
-
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Gets or sets a value indicating whether the text content wraps within a multiline
- RadTextBox.
-
-
- true if the text content wraps within a multiline RadTextBox; otherwise, false.
- The default is true.
-
-
- Use the Wrap property to specify whether the text displayed in a multiline
- RadTextBox control automatically continues on the next line when the text reaches the
- end of the control. This property is applicable only when the RadTextMode property is
- set to MultiLine
-
-
- The following code example demonstrates how to use the Wrap property to wrap
- text entered in the RadTextBox control. This example has a text box that accepts
- user input, which is a potential security threat. By default, ASP.NET Web pages
- validate that user input does not include script or HTML elements.
- [C#]
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <title>MultiLine RadTextBox Example </title>
<script runat="server">
- Protected Sub SubmitButton_Click(sender As Object, e As EventArgs )
Message.Text = "Thank you for your comment: <br />" + Comment.Text
End Sub
Protected Sub Check_Change(sender As Object, e As EventArgs )
-
-
- Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media
- Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP
- Starter Edition
- The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft
- Windows XP SP2, and Windows Server 2003 SP1.
- .NET Framework
- Supported in: 3.0, 2.0, 1.1, 1.0
-
-
-
-
- Creates a new Appointment object that is a clone of the current instance.
-
-
- A new Appointment object that is a clone of the current instance.
-
-
-
-
- The appointment duration.
-
-
- The duration can be zero.
-
-
-
-
- The Appointment subject.
-
-
-
-
- The Appointment description.
-
-
-
-
- Gets or sets a value indicating whether the editing of this appointment is allowed.
-
- true if editing of this appointment is allowed; otherwise, false.
-
-
-
- Gets or sets a value indicating whether the deleting of this appointment is allowed.
-
- true if the deleting of this appointment is allowed; otherwise, false.
-
-
-
- Gets or sets the data item represented by the
- Appointment object in the
- RadScheduler control.
-
-
- This property is available only during data binding.
-
-
-
-
- Creates an empty AppointmentCollection.
-
-
-
-
- Creates an AppointmentCollection
- and populates it with Appointment objects.
-
-
- The Appointment objects to add to the collection.
-
-
-
-
- Determines whether an element is in the AppointmentCollection.
-
-
- The Appointment to locate in the AppointmentCollection.
-
- true if item is found in the AppointmentCollection; otherwise, false.
-
- This method performs a linear search; therefore, this method is an O(n) operation, where n is Count.
-
-
-
-
- Copies the entire AppointmentCollection to a compatible one-dimensional Array,
- starting at the specified index of the target array.
-
-
- The one-dimensional Array that is the destination of the Appointments copied from AppointmentCollection.
- The Array must have zero-based indexing.
-
-
- The zero-based index in array at which copying begins.
-
-
-
-
- Searches for the specified Appointment and returns the zero-based index of the
- first occurrence within the entire AppointmentCollection.
-
-
- The Appointment to locate in the AppointmentCollection.
-
-
- The zero-based index of the first occurrence of value within the entire AppointmentCollection, if found; otherwise, -1.
-
-
-
-
- Searches for an Appointment with the specified ID and returns a reference to it.
-
-
- The AppointmentID to search for.
-
-
- The Appointment with the specified ID, if found; otherwise, null.
-
-
- This method determines equality by calling Object.Equals.
-
-
-
-
- Searches for all Appointments with the specified RecurrenceParentID
- and returns a generic IList containing them.
-
-
- The RecurrenceParentID to search for.
-
-
- A generic IList containing the Appointments with the specified RecurrenceParentID, if found.
-
-
- This method determines equality by calling Object.Equals.
-
- Appointments with recurrence state Exception
- are linked to their parents using the RecurrenceParentID property.
-
-
-
-
- Searches for all Appointments with the specified
- RecurrenceParentID and
- RecurrenceState.
-
-
- The RecurrenceParentID to search for.
-
-
- The RecurrenceState to search for.
-
-
- A generic IList containing the Appointments
- with the specified RecurrenceParentID and
- RecurrenceState, if found.
-
-
- This method determines equality by calling Object.Equals.
-
-
-
-
- Searches for all Appointments that
- start in the specified time range and returns a generic IList containing them.
-
-
- The start of the time range.
-
-
- The end of the time range.
-
-
- A generic IList containing the Appointments
- that start in the specified time range.
-
-
-
-
- Searches for all Appointments that
- overlap with the specified time range and returns a generic IList containing them.
-
-
- The start of the time range.
-
-
- The end of the time range.
-
-
- A generic IList containing the Appointments
- that overlap with the specified time range.
-
-
-
-
- Searches for all Appointments that
- are fully contained within the specified time range.
-
-
- The start of the time range.
-
-
- The end of the time range.
-
-
- A generic IList containing the Appointments
- that are fully contained within the specified time range.
-
-
-
-
- Copies the elements of the AppointmentCollection
- to a new Appointment array.
-
-
- An Appointment array containing copies of the elements of the
- AppointmentCollection.
-
-
-
-
- Returns an enumerator for the entire AppointmentCollection.
-
-
- An IEnumerator for the entire AppointmentCollection.
-
-
-
-
- Gets or sets the Appointment at the specified index.
-
- The zero-based index of the Appointment to get or set.
- The appointment at the specified index.
-
-
-
- Specifies the type of navigation commands that are supported by RadScheduler.
-
-
-
-
-
-
- Indicates that RadScheduler is about to switch to Day View as a result of user interaction.
-
-
-
-
- Indicates that RadScheduler is about to switch to Week View as a result of user interaction.
-
-
-
-
- Indicates that RadScheduler is about to switch to Month View as a result of user interaction.
-
-
-
-
- Indicates that RadScheduler is about to switch to Timeline View as a result of user interaction.
-
-
-
-
- Indicates that RadScheduler is about to switch to Multi-day View as a result of user interaction.
-
-
-
-
- Indicates that RadScheduler is about to switch to the next time period as a result of user interaction.
-
-
-
-
- Indicates that RadScheduler is about to switch to the previous time period as a result of user interaction.
-
-
-
-
- Indicates that RadScheduler is about to switch to a given date.
-
-
- This command occurs when:
-
- The "today" link in the header is clicked.
- A day header is clicked in Month View.
-
-
-
-
-
- Indicates that RadScheduler is about to switch from/to 24-hour view as a result of user interaction.
-
-
- Only applicable in Day and Week views.
- The current mode can be determined by inspecting the
- ShowFullTime property.
-
-
-
-
- Indicates that RadScheduler is about to adjust its visible range, so the previous appointment segment
- becomes visible.
-
-
- This command is a result of the user clicking the top arrow of an appointment.
- Depending on the current view RadScheduler will either switch to the previous
- time period or to 24-hour view.
-
-
-
-
- Indicates that RadScheduler is about to adjust its visible range, so the next appointment segment
- becomes visible.
-
-
- This command is a result of the user clicking the bottom arrow of an appointment.
- Depending on the current view RadScheduler will either switch to the next
- time period or to 24-hour view.
-
-
-
-
- Indicates that RadScheduler is about to switch to a different date that the
- user has selected from the integrated date picker.
-
-
-
-
- The type of navigation command that is being processed.
-
-
-
-
- The new date that has been selected.
-
-
- This property is applicable only for the
- NavigateToSelectedDate and
- SwitchToSelectedDay commands.
-
-
-
-
- The type of navigation command that has been processed.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Returns a synchronized (thread safe) wrapper for this provider instance.
-
- A synchronized (thread safe) wrapper for this provider instance.
-
-
-
- For internal use only.
-
-
-
-
-
-
- A RadScheduler provider that uses XML document as a data store.
-
-
-
-
- Format string for the dates. The "Z" appendix signifies UTC time.
-
-
-
-
- Initializes a new instance of the class.
-
- Name of the data file.
- if set to true the changes will be persisted.
-
-
-
- Initializes a new instance of the class.
-
- The document instance to use as a data store.
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- Initializes the provider.
-
- The friendly name of the provider.
- A collection of the name/value pairs representing the provider-specific attributes specified in the configuration for this provider.
- The name of the provider is null.
- An attempt is made to call on a provider after the provider has already been initialized.
- The name of the provider has a length of zero.
-
-
-
- Fetches appointments.
-
- The owner RadScheduler instance.
-
-
-
-
- Inserts the specified appointment.
-
- The owner RadScheduler instance.
- The appointment to insert.
-
-
-
- Updates the specified appointment.
-
- The owner RadScheduler instance.
- The appointment to update.
-
-
-
- Deletes the specified appointment.
-
- The owner RadScheduler instance.
- The appointment to delete.
-
-
-
- Gets the resource types.
-
- The owner RadScheduler instance.
-
-
-
-
- Gets the type of the resources by.
-
- The owner RadScheduler instance.
- Type of the resource.
-
-
-
- RadScheduler control class.
-
-
-
- For internal use only.
-
-
-
-
-
-
- Supports creating new Appointment instances.
-
-
-
-
- Creates a new Appointment instance.
-
-
- A new Appointment instance.
-
-
-
-
- Exports an appointment to iCalendar format.
-
-
- The return value should be saved as a text file with an "ics" extension.
-
- A string containing the appointment in iCalendar format.
- The appointment which should be exported.
-
-
-
- Exports an appointment to iCalendar format.
-
-
- The return value should be saved as a text file with an "ics" extension.
-
- A string containing the appointment in iCalendar format.
- The appointment which should be exported.
- The time zone offset to apply to the exported appointments.
-
-
-
- Exports the specified appointments to iCalendar format.
-
-
- The return value should be saved as a text file with an "ics" extension.
-
- A string containing the iCalendar representation of the supplied appointments.
- A collection of appointments which should be exported.
-
-
-
- Exports the specified appointments to iCalendar format.
-
-
- The return value should be saved as a text file with an "ics" extension.
-
- A string containing the iCalendar representation of the supplied appointments.
- An IEnumerable of appointments which should be exported.
-
-
-
- Exports the specified appointments to iCalendar format.
-
-
- The return value should be saved as a text file with an "ics" extension.
-
- A string containing the iCalendar representation of the supplied appointments.
- A collection of appointments which should be exported.
- The time zone offset to apply to the exported appointments.
-
-
-
- Exports the specified appointments to iCalendar format.
-
-
- The return value should be saved as a text file with an "ics" extension.
-
- A string containing the iCalendar representation of the supplied appointments.
- An IEnumerable of appointments which should be exported.
- The time zone offset to apply to the exported appointments.
-
-
-
- Creates a new appointment instance.
- This method is used internally by RadScheduler and can be used by custom appointment providers.
-
-
- A new appointment instance.
-
-
-
- Normally this is an instance of the Appointment class.
-
-
- This method can be overriden by inheritors to create instances of custom classes.
-
-
- An alternative method for working with custom appointments is to use the
- AppointmentFactory property.
-
-
-
-
-
-
- Returns the UTC date that corresponds to midnight on the client for the selected date.
-
- Client's date and time in UTC.
- The UTC date that corresponds to midnight on the client for the selected date.
-
-
-
- Shows the inline edit form.
-
-
- The appointment which is edited. Its properties are used to populate the edit form.
-
-
-
-
- Shows the inline edit form.
-
-
- The appointment which is edited. Its properties are used to populate the edit form.
-
-
- A boolean value indicating whether to edit the recurring series.
-
-
-
-
- Shows the advanced edit form.
-
-
- The appointment which is edited. Its properties are used to populate the edit form.
-
-
-
-
- Shows the advanced edit form.
-
-
- The appointment which is edited. Its properties are used to populate the edit form.
-
-
- A boolean value indicating whether to edit the recurring series.
-
-
-
-
- Shows the inline insert form.
-
-
- Specifies the start time for the insert form. It is used to determine the row in which the form is shown.
-
-
-
-
- Shows the inline insert form.
-
- The time slot object where the insert form will be shown
-
-
-
- Shows the advansed insert form.
-
-
- Specifies the start time for the insert form. It is used to determine the row in which the form is shown.
-
-
-
-
- Shows the all-day inline insert form
-
-
- Specifies the start time for the insert form. It is used to determine the row in which the form is shown.
-
-
-
-
- Retrieves a TimeSlot object from its client-side index
-
- String representation of the TimeSlot's index
- The TimeSlot that corresponds to the passed index
-
-
-
- Hides the active insert or edit form (if any).
-
-
-
-
- Converts a date time object from UTC to client date format using the TimeZoneOffset property.
-
- The date to convert. Must be in UTC format.
-
- The date in client format which corresponds to the supplied UTC date
-
-
- RadScheduler always stores dates in UTC format to allow support for multiple time zones.
- The UtcToDisplay method must be used when
- a date (e.g. Appointment.Start)
- should be presented to the client in some way - e.g. displayed in a label.
-
-
-
- Appointment appointment = RadScheduler1.Appointments[0];
- Label1.Text = RadScheduler1.UtcToDisplay(appointment.Start).ToString()
-
-
- Dim appointment As Appointment = RadScheduler1.Appointments(0)
- Label1.Text = RadScheduler1.UtcToDisplay(appointment.Start).ToString()
-
-
-
-
-
- Converts a date time object from client date format to UTC using the TimeZoneOffset property.
-
- The date to convert. Must be in client format.
-
- The date in UTC format which corresponds to the supplied client format date.
-
-
- RadScheduler always stores dates in UTC format to allow support for multiple time zones. The DisplayToUtc method must be used when
- a date is supplied to RadScheduler to be persisted in some way. For example updating the Appointment.Start property from a textbox.
-
-
-
- Appointment appointment = RadScheduler1.Appointments[0];
- DateTime startInClientFormat = DateTime.Parse(TextBox1.Text);
- appointment.Start = RadScheduler1.DisplayToUtc(startInClientFormat);
- RadScheduler1.Update(appointment);
-
-
- Dim appointment As Appointment = RadScheduler1.Appointments(0)
- Dim startInClientFormat As DateTime = DateTime.Parse(TextBox1.Text)
- appointment.Start = RadScheduler1.DisplayToUtc(startInClientFormat)
- RadScheduler1.Update(appointment)
-
-
-
-
-
- Inserts the specified appointment in the Appointments collection,
- expands the series (if it is recurring) and inserts persists it through the provider.
-
- The appointment to insert.
-
-
-
- Updates the specified appointment and persists the changes through the provider.
-
-
- This method can be used, along with PrepareToEdit
- to create and persist a recurrence exceptions.
-
-
-
- Appointment occurrence = RadScheduler1.Appointments[0];
- Appointment recurrenceException = RadScheduler1.PrepareToEdit(occurrence, false);
-
- recurrenceException.Subject = "This is a recurrence exception";
-
- RadScheduler1.UpdateAppointment(recurrenceException);
-
-
- Dim occurrence As Appointment = RadScheduler1.Appointments(0)
- Dim recurrenceException as Appointment = RadScheduler1.PrepareToEdit(occurrence, False)
-
- recurrenceException.Subject = "This is a recurrence exception"
-
- RadScheduler1.UpdateAppointment(recurrenceException)
-
-
- The appointment to update.
-
-
-
- Updates the specified appointment and persists the changes through the provider.
-
- Use this overload when the underlying data source requires both original and modified
- data to perform an update operation. One such example is LinqDataSource.
-
-
- This method can be used, along with PrepareToEdit
- to create and persist a recurrence exceptions.
-
-
-
- Appointment occurrence = RadScheduler1.Appointments[0];
- Appointment recurrenceException = RadScheduler1.PrepareToEdit(occurrence, false);
-
- Appointment modifiedAppointment = recurrenceException.Clone();
- modifiedAppointment.Subject = "This is a recurrence exception";
-
- RadScheduler1.UpdateAppointment(modifiedAppointment, recurrenceException);
-
-
- Dim occurrence As Appointment = RadScheduler1.Appointments(0)
- Dim recurrenceException as Appointment = RadScheduler1.PrepareToEdit(occurrence, False)
-
- Dim modifiedAppointment = recurrenceException.Clone()
- modifiedAppointment.Subject = "This is a recurrence exception"
-
- RadScheduler1.UpdateAppointment(modifiedAppointment, recurrenceException)
-
-
- The appointment to update.
-
- The original appointment. Use Appointment.Clone
- to obtain a copy of the appointment before updating its properties.
-
-
-
-
- Prepares the specified appointment for editing.
-
-
- If the specified appointment is not recurring, the method does nothing and returns the same appointment.
- If the appointment is recurring and editSeries is set to true the method returns the recurrence parent.
- Otherwise, the method clones the appointment and updates it state to recurrence exception.
-
-
-
- Appointment occurrence = RadScheduler1.Appointments[0];
- Appointment recurrenceException = RadScheduler1.PrepareToEdit(occurrence, false);
-
- recurrenceException.Subject = "This is a recurrence exception";
-
- RadScheduler1.UpdateAppointment(recurrenceException);
-
-
- Dim occurrence As Appointment = RadScheduler1.Appointments(0)
- Dim recurrenceException as Appointment = RadScheduler1.PrepareToEdit(occurrence, False)
-
- recurrenceException.Subject = "This is a recurrence exception"
-
- RadScheduler1.UpdateAppointment(recurrenceException)
-
-
- The appointment to edit.
- if set to true [edit series].
-
-
-
-
- Deletes the appointment or the recurrence series it is part of.
-
-
- When deleting an appointment that is part of recurrence series and deleteSeries is set to false
- this method will update the master appointment to produce a recurrence exception.
-
- The appointment to delete.
- if set to true delete complete recurrence series.
-
-
-
- Removes the associated recurrence exceptions through the provider.
-
- The recurrence master.
-
-
-
- Indicates whether to instantiate a clent-side object for the
- advanced insert form (applicable only in Web Service mode).
-
-
-
-
- Indicates whether to instantiate a clent-side object for the
- advanced edit form (applicable only in Web Service mode).
-
-
-
-
- Gets a collection of Appointment objects that represent individual
- appointments in the RadScheduler control.
-
-
- A collection of the currently loaded Appointment objects.
-
-
-
-
- A factory for appointment instances.
-
-
-
- The default factory returns instances of the
- Appointment class.
-
-
- RadScheduler needs to create appointment instances in various
- stages of the control life cycle. You can use custom appointment
- classes by either implementing an IAppointmentFactory or by overriding
- the CreateAppointment method.
-
-
-
-
-
- A collection of all resources loaded by RadScheduler.
-
-
-
-
- Returns visible start date of the current view.
-
-
- All tasks rendered in the current view will be within the range specified by the VisibleRangeStart
- and VisibleRangeEnd properties.
-
-
-
-
- Returns visible end date of the current view.
-
-
- All tasks rendered in the current view will be within the range specified by the VisibleRangeStart
- and VisibleRangeEnd properties.
-
-
-
-
- Gets a value indicating whether the recurring series are being edited at the moment, as opposed to a single appointment of the series.
-
-
- This property is also used to indicate the target of the delete and move operations.
-
-
- true if the recurring series are being edited at the moment; false otherwise.
-
-
-
-
- Gets a boolean value that indicates if recurrence support has been configured for this
- instance of RadScheduler.
-
-
-
-
-
- True when the
- DataRecurrenceField and
- DataRecurrenceParentKeyField
- fields are set or when using a custom data provider.
-
- False if either of the above conditions is not satisfied
- or when the EnableRecurrenceSupport property
- is set to false.
-
-
-
-
- One of the SchedulerViewType values. The
- default is DayView.
-
- Gets or sets the current view type.
-
-
-
- Gets the name of the resource to group by.
- Can also be in the format "Date,[Resource Name]" when grouping by date.
-
- The resource to group by.
-
-
-
- Gets or sets a value indicating whether the user can use the advanced insert/edit form.
-
- true if the user should be able to use the advanced insert/edit form; false otherwise. The default value is true.
-
-
-
- Gets or sets a value indicating whether "advanced" mode is the default edit mode.
-
- true if the "advanced" mode is the default edit mode; false if "inline" is default edit mode. The default value is true.
-
-
-
- Gets or sets a value indicating whether "advanced" mode is the default insert mode.
-
- true if the "advanced" mode is the default insert mode; false if "inline" is default insert mode. The default value is false.
-
-
-
- Gets or sets a value indicating whether a delete confirmation dialog should be displayed when the user clicks the "delete" button of an appointment.
-
-
- true if the confirmation dialog should be displayed; false otherwise. The default value is true.
-
-
-
-
- Gets or sets a value indicating whether a confirmation dialog should be displayed when the user moves a recurring appointment.
-
-
- true if the confirmation dialog should be displayed; false otherwise. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether RadScheduler is in read-only mode.
-
-
- true if RadScheduler should be read-only; false otherwise. The default value is false.
-
-
- By default the user is able to insert, edit and delete appointments. Use the ReadOnly to disable the editing capabilities of RadScheduler.
-
-
-
-
- Gets a collection of ResourceType objects that represent
- the resource types used by RadScheduler.
-
-
-
-
- Gets a collection of ResourceStyleMapping
- objects can be used to associate resources with particular
- cascading style sheet (CSS) classes.
-
-
- Resources are matched by all (boolean AND) specified properties.
-
-
-
-
- Gets or sets the time zone offset to use when displaying appointments.
-
- The time zone offset to use when displaying appointments.
- The default value is TimeSpan.Zero.
-
-
-
- Gets or sets the time zone offset to use when determining todays date.
-
- The time zone offset to use when determining todays date.
-
- The default value is the system's time zone offset.
- This value is ignored when TimeZoneOffset is set.
-
-
-
-
- The meaning of this property is different depending on the current
- view type.
- In day view mode SelectedDate
- gets or sets the currently displayed date.
- In week and
- month view modes SelectedDate
- gets or sets the highlighted date in the current week or month.
-
-
-
-
- Gets or sets the number of rows each time label spans.
-
-
- The number of rows each time label spans. The default value is 2
-
-
-
- Gets or sets the number of minuties which a single row represents
-
- An integer specifying how many minutes a row represents. The default value is 30.
-
-
-
- Gets or sets the number of rows that are hovered when the mouse is over the appointment area.
-
- An integer specifying the number of rows that are hovered when the mouse is over the appointment area.
- The default value is 2.
- This value also determines the initial length of inserted appointments.
-
-
-
-
- Gets or sets the time used to denote the start of the day.
-
-
- The time used to denote the start of the day.
-
-
- This property is ignored in month view mode.
-
-
-
-
- Gets or sets the time used to denote the end of the day.
-
-
- The time used to denote the end of the day.
-
-
- This property is ignored in month view mode.
-
-
-
-
- Gets or sets the time used to denote the start of the work day.
-
-
- The time used to denote the start of the work day.
-
-
- The effect from this property is only visual.
- This property is ignored in month view mode.
-
-
-
-
- Gets or sets the time used to denote the end of the work day.
-
-
- The time used to denote the end of the work day.
-
-
- The effect from this property is only visual.
- This property is ignored in month view mode.
-
-
-
-
- Gets or sets a value that indicates whether the resource editing in the advanced form is enabled.
-
- A value that indicates whether the resource editing in the advanced form is enabled.
-
-
-
- Gets or sets a value that indicates whether the attribute editing in the advanced form is enabled.
-
- A value that indicates whether the attribute editing in the advanced form is enabled.
-
-
-
- Gets or sets the first day of the week.
-
-
- Used this property to specify the first day rendered in week view.
-
-
-
-
- Gets or sets the last day of the week.
-
-
- This property is applied in week and month view.
-
-
-
-
- Gets or sets a value specifying the way RadScheduler should behave when its content
- overflows its dimensions.
-
-
- One of the OverflowBehavior values. The default value is OverflowBehavior.Scroll.
-
-
- By default RadScheduler will render a scrollbar should its content exceed the specified dimensions
- (set via the Width and Height properties). If
- OverflowBehavior.Expand is set RadScheduler
- will expand vertically. The Height property must not be set in that case.
-
-
-
-
- Gets or sets a value indicating whether to render the hours column in day and week view.
-
- true if the hours column is rendered in day and week view; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render date headers for the current view.
-
- true if the date headers for the current view are rendered; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render resource headers for the current view.
-
- true if the resource headers for the current view are rendered; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render the header.
-
- true if the header is rendered; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render the footer.
-
- true if the footer is rendered; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render the navigation links..
-
- true if the header is rendered; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render the tabs for switching between the view types.
-
- true if the tabs is rendered; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render the all day pane.
-
- true if the header is rendered; otherwise, false.
-
-
-
- Gets or sets the edit form date format string.
-
- The edit form date format string.
-
-
-
- Gets or sets the edit form time format string.
-
- The edit form time format string.
-
-
-
- Gets or sets the hours panel time format string.
-
- The hours panel time format string.
-
-
-
- Gets or sets a value indicating whether to display the complete day (24-hour view) or the range between DayStartTime and DayEndTime.
-
- true if showing the complete day (24-hour view); otherwise, false.
-
-
-
- Gets or sets the resource grouping direction of the RadScheduler.
-
-
-
-
- Gets or sets a value indicating whether to enable the date picker for quick navigation.
-
- true if the date picker for quick navigation is enabled; otherwise, false.
-
-
-
- Gets or sets the height of RadScheduler rows.
-
- The height of a RadScheduler row
-
-
-
- Gets or sets the width of each content column.
-
- The width of each content column
-
-
-
- Gets or sets the width of each row header.
-
- The width of each row header
-
-
-
- Gets or sets the minimum height of the inline insert/edit template.
-
-
- The height is applied to the textbox inside the default inline template.
- It will be ignored when using custom templates for the inline form.
-
- The minimum height of the inline insert/edit template.
-
-
-
- Gets or sets the minimum width of the inline insert/edit template.
-
- The minimum width of the inline insert/edit template.
-
-
-
- Gets a collection of RadSchedulerContextMenu objects
- that represent the time slot context menus of the RadScheduler control.
-
-
-
-
- Gets a collection of RadSchedulerContextMenu objects
- that represent the Appointment context menus of the RadScheduler control.
-
- A RadSchedulerContextMenuCollection that
- contains all the Appointment context menus of the RadScheduler control.
-
-
- By default, if the AppointmentContextMenus collection contains RadSchedulerContextMenus,
- the first one is displayed on the right-click of each Appointment.
- To specify a different context menu for a Appointment, use its
- ContextMenuID property.
-
-
- The following code example demonstrates how to populate the AppointmentContextMenus
- collection declaratively.
-
- <%@ Page Language="C#" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <telerik:RadScheduler runat="server" ID="RadScheduler1">
- <AppointmentContextMenus>
- <telerik:RadSchedulerContextMenu runat="server" ID="ContextMenu1">
- <Items>
- <telerik:RadMenuItem Text="Open" Value="CommandEdit" />
- <telerik:RadMenuItem IsSeparator="True" />
- <telerik:RadMenuItem Text="Categorize">
- <Items>
- <telerik:RadMenuItem Text="Development" Value="1" />
- <telerik:RadMenuItem Text="Marketing" Value="2" />
- <telerik:RadMenuItem Text="Personal" Value="3" />
- <telerik:RadMenuItem Text="Work" Value="4" />
- </Items>
- </telerik:RadMenuItem>
- <telerik:RadMenuItem IsSeparator="True" />
- <telerik:RadMenuItem Text="Delete" ImageUrl="Images/delete.gif" Value="CommandDelete" />
- </Items>
- </telerik:RadSchedulerContextMenu>
- </AppointmentContextMenus>
- </telerik:RadScheduler>
-
- </form>
- </body>
- </html>
-
-
-
-
-
- Gets or sets the name of the validation group to be used for the integrated validation controls.
-
-
-
-
- Overridden. Gets or sets the ID property of the data source control that the
- RadScheduler should use to retrieve its data source.
-
-
-
-
- Gets or sets the provider instance to be used by RadScheduler. Use this property
- with providers that are created at runtime. For ASP.NET providers defined in web.config
- use the ProviderName property.
-
-
- The provider instance to be used by RadScheduler.
-
-
-
-
- Gets or sets the name of the current appointment provider used by RadScheduler. The provider
- must be defined in the RadScheduler section of web.config.
-
-
- The name of the current appointment provider used by RadScheduler as defined in web.config.
-
-
-
-
- Gets the current provider context. The context object contains
- additional information about the currently performed operation,
- that can be used to improve and optimize provider implementations.
-
-
- The current provider context.
- The context object can be of type
- UpdateAppointmentContext or
- CreateRecurrenceExceptionContext.
-
-
-
-
- Gets or sets the key field for appointments in the data source specified by the
- DataSourceID property.
-
-
- The name of the key field for appointments in the data source specified by
- DataSourceID.
-
-
-
-
- Gets or sets the subject field for appointments in the data source specified by the
- DataSourceID property.
-
-
- The name of the subject field for appointments in the data source specified by
- DataSourceID.
-
-
-
-
- Gets or sets the description field for appointments in the data source specified by the
- DataSourceID property.
-
-
- The name of the description field for appointments in the data source specified by
- DataSourceID.
-
-
- This property is optional. If it's not specified the description field will not be
- visible in the insert/edit forms.
- Setting this property to a non-empty string will enable the Description field
- regardless of the value of EnableDescriptionField.
-
-
-
-
- Gets or sets the end field for appointments in the data source specified by the
- DataSourceID property.
-
-
- The name of the end field for appointments in the data source specified by
- DataSourceID.
-
-
-
-
- Gets or sets the start field for appointments in the data source specified by the
- DataSourceID property.
-
-
- The name of the start field for appointments in the data source specified by
- DataSourceID.
-
-
-
-
- Gets or sets the recurrence rule field for appointments in the data source specified by
- the DataSourceID property.
-
-
- The name of the recurrene rule field for appointments in the data source specified by
- DataSourceID.
-
-
-
-
- Gets or sets the recurrence parent key field for appointments in the data source specified
- by the DataSourceID property.
-
-
- The name of the recurrence parent key field for appointments in the data source specified
- by DataSourceID.
-
-
-
-
- Specifies the database fields (column names) which should be loaded as appointment attributes.
-
-
- An array of strings representing the names of the database fields which should be populated as appointment custom attributes. By default RadScheduler does not populate any
- database fields as custom attributes.
-
-
- You should use the CustomAttributeNames property when you want RadScheduler to populate the Attributes collection of the appointments.
-
-
-
-
- Gets or sets the comparer instance used to determine the appointment ordering within the same slot.
- By default, appointments are ordered by start time and duration.
-
-
-
-
- Gets or sets the maximum recurrence candidates limit.
-
-
- This limit is used to prevent lockups when evaluating long recurring series.
- The default value should not be changed under normal conditions.
-
- The maximum recurrence candidates limit.
-
-
-
- Gets or sets a value indicating whether the user can create and edit recurring appointments.
-
- true if the user is allowed to create and edit recurring appointments; false otherwise. The default value is true.
-
-
-
- Gets or sets a value indicating whether the user can view and edit the description field of appointments.
-
-
- true if the user is allowed to view and edit the description field of appointments;
- false otherwise. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether appointments editing is allowed.
-
- true if appointments editing is allowed; otherwise, false.
-
-
-
- Gets or sets a value indicating whether appointments deleting is allowed.
-
- true if appointments deleting is allowed; otherwise, false.
-
-
-
- Gets or sets a value indicating whether appointments inserting is allowed.
-
- true if appointments inserting is allowed; otherwise, false.
-
-
-
- Occurs when a button is clicked within the appointment template.
-
-
- The AppointmentCommand event is raised when any button is clicked withing the appointment template.
- This event is commonly used to handle button controls with a custom CommandName value.
-
-
-
- void RadScheduler1_AppointmentCommand(object sender, AppointmentCommandEventArgs e)
- {
- if (e.CommandName == "Delete")
- {
- Delete(e.Container.Appointment);
- }
- }
-
-
- Sub RadScheduler1_AppointmentCommand(sender As Object, e As AppointmentCommandEventArgs)
- If e.CommandName = "Delete" Then
- Delete(e.Container.Appointment)
- End If
- End Sub
-
-
-
-
-
- Occurs when an appointment context menu item is clicked, before processing default commands.
-
-
- The AppointmentContextMenuItemClicking event is raised when an appointment context menu item is clicked, before are processing default commands.
-
-
-
-
- Occurs after an appointment context menu item is clicked.
-
-
- The AppointmentContextMenuItemClicked event is raised after an appointment context menu item is clicked.
-
-
-
-
- Occurs when a time slot context menu item is clicked, before processing default commands.
-
-
- The TimeSlotContextMenuItemClicking event is raised when a time slot context menu item is clicked, before are processing default commands.
-
-
-
-
- Occurs after a time slot context menu item is clicked.
-
-
- The TimeSlotContextMenuItemClicked event is raised after a time slot context menu item is clicked.
-
-
-
-
- Occurs when an appointment is about to be inserted in the database through the provider.
-
-
- The insert operation can be cancelled by setting the
- SchedulerCancelEventArgs.Cancel
- property of SchedulerCancelEventArgs to true.
-
-
-
- void RadScheduler1_AppointmentInsert(object sender, SchedulerCancelEventArgs e)
- {
- if (e.Appointment.Subject == String.Empty)
- {
- e.Cancel = true;
- }
- }
-
-
- Sub RadScheduler1_AppointmentInsert(sender As Object, e As SchedulerCancelEventArgs)
- If e.Appointment.Subject = String.Empty Then
- e.Cancel = True
- End If
- End Sub
-
-
-
-
-
- Occurs when an appointment is about to be updated through the provider.
-
-
- The AppointmentUpdateEventArgs hold a reference both
- to the original and the modified appointment. Any modifications on the original appointments are
- discarded.
- The update operation can be cancelled by setting the
- AppointmentUpdateEventArgs.Cancel
- property of AppointmentUpdateEventArgs to true.
-
-
-
- void RadScheduler1_AppointmentUpdate(object sender, AppointmentUpdateEventArgs e)
- {
- e.ModifiedAppointment.End = e.ModifiedAppointment.End.AddHours(1);
- }
-
-
- Sub RadScheduler1_AppointmentUpdate(sender As Object, e As AppointmentUpdateEventArgs)
- e.ModifiedAppointment.End = e.ModifiedAppointment.End.AddHours(1)
- End Sub
-
-
-
-
-
- Occurs when an appointment is about to be deleted from the database through the provider.
-
-
- The delete operation can be cancelled by setting the
- SchedulerCancelEventArgs.Cancel
- property of SchedulerCancelEventArgs to true.
-
-
-
- void RadScheduler1_AppointmentDelete(object sender, SchedulerCancelEventArgs e)
- {
- if (e.Appointment.Attributes["ReadOnly"] == "true")
- {
- e.Cancel = true;
- }
- }
-
-
- Sub RadScheduler1_AppointmentDelete(sender As Object, e As SchedulerCancelEventArgs)
- If e.Appointment.Attributes("ReadOnly") = "true" Then
- e.Cancel = True
- End If
- End Sub
-
-
-
-
-
- Occurs when an appointment template has been instantiated.
-
-
- You can use this event to modify the appointment template before data binding.
-
-
-
- void RadScheduler1_AppointmentCreated(object sender, AppointmentCreatedEventArgs e)
- {
- Label testLabel = (Label) e.Container.FindControl("Test");
- testLabel.Text = "Test";
- }
-
-
- Sub RadScheduler1_AppointmentCreated(sender As Object, e As AppointmentCreatedEventArgs)
- Dim testLabel As Label = CType(e.Container.FindControl("Test"), Label)
- testLabel.Text = "Test"
- End Sub
-
-
-
-
-
- Occurs when an appointment has been added to the Appointments collection from the data source.
-
-
- You can use this event to make adjustments to the appointments as they are being loaded.
-
-
-
- void RadScheduler1_AppointmentDataBound(object sender, SchedulerEventArgs e)
- {
- e.Appointment.Start = e.Appointment.Start.AddHours(1);
- }
-
-
- Sub RadScheduler1_AppointmentDataBound(sender As Object, e As SchedulerEventArgs)
- e.Appointment.Start = e.Appointment.Start.AddHours(1)
- End Sub
-
-
-
-
-
- Occurs when an appointment has been clicked.
-
-
- You can use this event to perform additional actions when an appointment has been clicked.
-
-
-
- void RadScheduler1_AppointmentClick(object sender, SchedulerEventArgs e)
- {
- Response.Redirect("Page.aspx);
- }
-
-
- Sub RadScheduler1_AppointmentClick(sender As Object, e As SchedulerEventArgs)
- Response.Redirect("Page.aspx)
- End Sub
-
-
-
-
-
- Occurs when the RadScheduler is about to execute a navigation command.
-
-
- You can use this event to customize the action when the RadScheduler is about to execute a navigation command.
- The event can be cancelled by setting the
- SchedulerNavigationCommandEventArgs.Cancel
- property of SchedulerNavigationCommandEventArgs to true.
-
-
-
- void RadScheduler1_NavigationCommand(object sender, SchedulerNavigationCommandEventArgs e)
- {
- if (e.Command == SchedulerNavigationCommand.NavigateToNextPeriod)
- {
- e.Cancel = true;
- }
- }
-
-
- Sub RadScheduler1_NavigationCommand(sender As Object, e As SchedulerNavigationCommandEventArgs)
- If e.Command = SchedulerNavigationCommand.NavigateToNextPeriod Then
- e.Cancel = True
- End If
- End Sub
-
-
-
-
-
- Occurs when a navigation command has been executed.
-
-
- You can use this event to perform custom actions when a navigation command has been processed.
-
-
-
- void RadScheduler1_NavigationComplete(object sender, SchedulerNavigationCompleteEventArgs e)
- {
- Label1.Text = RadScheduler1.SelectedDate;
- }
-
-
- Sub RadScheduler1_NavigationComplete(sender As Object, e As SchedulerNavigationCompleteEventArgs)
- Label1.Text = RadScheduler1.SelectedDate
- End Sub
-
-
-
-
-
- Occurs when an insert/edit form is being created.
-
-
- You can use this event to perform custom actions when a form is about to be created.
- The event can be cancelled by setting the
- SchedulerFormCreatingEventArgs.Cancel
- property of SchedulerFormCreatingEventArgs to true.
-
-
-
- void RadScheduler1_FormCreating(object sender, SchedulerFormCreatingEventArgs e)
- {
- if (e.Mode == SchedulerFormMode.Insert)
- {
- e.Cancel = true;
- }
- }
-
-
- Sub RadScheduler1_FormCreating(sender As Object, e As SchedulerFormCreatingEventArgs)
- If e.Mode = SchedulerFormMode.Insert Then
- e.Cancel = True
- End If
- End Sub
-
-
-
-
-
- Occurs when an insert/edit form has been created.
-
-
- You can use this event to make modifications to the form template.
-
-
-
- void RadScheduler1_FormCreated(object sender, SchedulerFormCreatedEventArgs e)
- {
- if (e.Container.Mode == SchedulerFormMode.Insert)
- {
- Label startDate = (Label) e.Container.FindControl("StartDate");
- startDate.Text = e.Container.Appointment.Start;
- }
- }
-
-
- Sub RadScheduler1_FormCreated(sender As Object, e As SchedulerFormCreatedEventArgs)
- If e.Container.Mode = SchedulerFormMode.Insert Then
- Dim startDate As Label = CType(e.Container.FindControl("StartDate"), Label)
- startDate.Text = e.Container.Appointment.Start
- End If
- End Sub
-
-
-
-
-
- Occurs when the Cancel button of an edit form is clicked, but before RadScheduler exits edit mode.
-
-
- You can use this event to provide an event-handling method that performs a custom routine,
- such as stopping the cancel operation if it would put the appointment in an undesired state.
- To stop the cancel action set the
- AppointmentCancelingEditEventArgs.Cancel
- property of AppointmentCancelingEditEventArgs to true.
-
-
-
- void RadScheduler1_FormCreated(object sender, SchedulerFormCreatedEventArgs e)
- {
- if (e.Container.Mode == SchedulerFormMode.Insert)
- {
- TextBox startDate = (TextBox) e.Container.FindControl("StartDate");
- if (startDate.Text == String.Empty)
- {
- e.Cancel = true;
- }
- }
- }
-
-
- Sub RadScheduler1_FormCreated(sender As Object, e As SchedulerFormCreatedEventArgs)
- If e.Container.Mode = SchedulerFormMode.Insert Then
- Dim startDate As TextBox = CType(e.Container.FindControl("StartDate"), TextBox)
- If startDate.Text = String.Empty Then
- e.Cancel = true
- End If
- End If
- End Sub
-
-
-
-
-
- Occurs when a time slot has been created.
-
-
- You can use this event to make modifications to the time slots.
-
-
-
- void RadScheduler1_TimeSlotCreated(object sender, TimeSlotCreatedEventArgs e)
- {
- e.TimeSlot.CssClass = "holidayTimeSlot";
- }
-
-
- Sub RadScheduler1_TimeSlotCreated(sender As Object, e As TimeSlotCreatedEventArgs)
- e.TimeSlot.CssClass = "holidayTimeSlot"
- End Sub
-
-
-
-
-
- Occurs when a resource header has been created.
-
-
- You can use this event to make modifications to the resouce headers.
-
-
-
- void RadScheduler1_TimeSlotCreated(object sender, TimeSlotCreatedEventArgs e)
- {
- e.Container.Controls.Add(new LiteralControl("Test"));
- }
-
-
- Sub RadScheduler1_TimeSlotCreated(sender As Object, e As TimeSlotCreatedEventArgs)
- e.Container.Controls.Add(new LiteralControl("Test"))
- End Sub
-
-
-
-
-
- Occurs when an occurrence is about to be removed.
-
-
- The OccurrenceDeleteEventArgs hold a reference both
- to the master and the occurrence appointment.
- The operation can be cancelled by setting the
- Cancel
- property of OccurrenceDeleteEventArgs to true.
-
-
-
- void RadScheduler1_OccurrenceDelete(object sender, OccurrenceDeleteEventArgs e)
- {
- e.Cancel = true;
- }
-
-
- Sub RadScheduler1_OccurrenceDelete(sender As Object, e As OccurrenceDeleteEventArgs)
- e.Cancel = true
- End Sub
-
-
-
-
-
- Occurs when an appointment that represents a recurrence exception is about to be created.
-
-
- The RecurrenceExceptionCreatedEventArgs hold a reference both
- to the master and the exception appointment.
- The operation can be cancelled by setting the
- Cancel
- property of RecurrenceExceptionCreatedEventArgs to true.
-
-
-
- void RadScheduler1_RecurrenceExceptionCreated(object sender, RecurrenceExceptionCreatedEventArgs e)
- {
- e.Cancel = true;
- }
-
-
- Sub RadScheduler1_RecurrenceExceptionCreated(sender As Object, e As RecurrenceExceptionCreatedEventArgs)
- e.Cancel = true
- End Sub
-
-
-
-
-
- Occurs when the scheduler is about to request resources from the Web Service.
-
-
-
- Resources need to be populated from the server when using resource grouping.
- Doing so also reduces the client-side initialization time.
-
-
- This operation requires the WebPermission to be granted
- for the Web Service URL. This permission is not granted by default in Medium Trust.
-
-
- You can disable the population of the resources from the server and still use
- client-side rendering for grouped views. To do so you need to set the
- WebServiceSettings.ResourcePopulationMode
- to Manual and
- populate the resources from the OnInit method of the page.
-
-
- The ResourcesPopulatingEventArgs
- contains additional information about the request that is about to be made.
- You can use its properties to modify the URL, supply credentials and so on.
-
-
- The operation can be cancelled by setting the
- ResourcesPopulatingEventArgs.Cancel
- property of ResourcesPopulatingEventArgs to true.
-
-
-
-
- void RadScheduler1_ResourcesPopulating(object sender, ResourcesPopulatingEventArgs e)
- {
- e.Cancel = true;
- }
-
-
- Sub RadScheduler1_ResourcesPopulating(sender As Object, e As ResourcesPopulatingEventArgs)
- e.Cancel = true
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment is about to be moved.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientAppointmentMoveStartHandler(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentMoveStart="onClientAppointmentMoveStartHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentMoveStart client-side event
- handler is called when an appointment is about to be moved.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with four properties:
-
- get_appointment(), the instance of the appointment.
- set_cancel(), set to true to cancel the move operation.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment is being moved.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientAppointmentMovingHandler(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- var targetSlot = eventArgs.get_targetSlot();
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentMoving="onClientAppointmentMovingHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentMoving client-side event
- handler is called when an appointment is being moved.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with four properties:
-
- get_appointment(), the instance of the appointment.
- get_targetSlot(), the slot that the appointment currently occupies.
- set_cancel(), set to true to cancel the move operation.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment has been moved.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientAppointmentMoveEndHandler(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- var newStartTime = eventArgs.get_newStartTime();
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentMoveEnd="onClientAppointmentMoveEndHandler">
- ....
- </telerik:RadScheduler>
-
-
-
- If specified, the OnClientAppointmentMoveEnd client-side event
- handler is called when an appointment has been moved.
-
-
- The event will also be fired when the move operation has been aborted by the
- user. In this case the get_isAbortedByUser() property of the event arguments will
- be set to "true".
-
-
- The event will also fire if the appointment is dropped in its original location,
- but no postback will occur as the appointment is not altered.
-
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with six properties:
-
- get_appointment(), the instance of the appointment.
- get_newStartTime(), the new start time of the appointment.
- get_editingRecurringSeries(), a boolean value indicating whether the user has selected to edit the whole series.
- get_targetSlot(), the target slot that the appointment has been moved to.
- get_isAbortedByUser(), indicates whether the move operation has been aborted as a result of user action.
- set_cancel(), set to true to cancel the move operation.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the recurrence action confirmation dialog is about to be shown.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientRecurrenceActionDialogShowingHandler(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- var action = eventArgs.get_recurrenceAction();
-
- if (action == Telerik.Web.UI.RecurrenceAction.Edit)
- {
- alert("Overriding recurrence action dialog to 'Edit series' for appointment '" + appointment.get_subject() + "'");
- eventArgs.set_cancel(true);
- eventArgs.set_editSeries(true);
- }
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientRecurrenceActionDialogShowing="onClientRecurrenceActionDialogShowingHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientRecurrenceActionDialogShowing client-side event
- handler is called when the recurrence action confirmation dialog is about to be shown.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with three properties:
-
- get_appointment(), the instance of the appointment.
- set_cancel(), set to true to suppress the confirmation dialog.
- set_editSeries(), set to true or false to override the result from the dialog (only if it has been cancelled by calling eventArgs.set_cancel(true)).
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the recurrence action confirmation dialog has been closed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientRecurrenceActionDialogClosedHandler(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- var editSeries = eventArgs.get_editSeries();
-
- alert("The user has set editSeries to '" + editSeries + "' for appointment '" + appointment.get_subject() + "'");
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientRecurrenceActionDialogClosed="onClientRecurrenceActionDialogClosedHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientRecurrenceActionDialogClosed client-side event
- handler is called when the recurrence action confirmation dialog has been closed.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with three properties:
-
- get_appointment(), the instance of the appointment.
- get_editSeries(), the selected option from the dialog.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an edit/insert form has been created.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientFormCreatedHandler(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- var formElement = eventArgs.get_formElement();
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientFormCreated="onClientFormCreatedHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientFormCreated client-side event
- handler is called when an edit/insert form has been created.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the instance of the appointment.
- get_formElement(), the DOM element of the form.
- get_mode(), enumerable of type Telerik.Web.UI.SchedulerFormMode.
- See SchedulerFormMode for the list of possible values.
- get_editingRecurringSeries(), a boolean indicating if the user
- has chosen to edit the recurring series (true) or a single occurrence (false).
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment has been right-clicked.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientAppointmentContextMenuHandler(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- // ...
- eventArgs.get_domEvent().preventDefault(); // Prevent displaying the browser menu
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentContextMenu="onClientAppointmentContextMenuHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentContextMenu client-side event
- handler is called when an appointment has been right-clicked.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the instance of the appointment.
- get_domEvent(), the original DOM event.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an empty time slot has been right-clicked.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function onClientTimeSlotContextMenuHandler(sender, eventArgs)
- {
- var time = eventArgs.get_time();
- // ...
- eventArgs.get_domEvent().preventDefault(); // Prevent displaying the browser menu
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientTimeSlotContextMenu="onClientTimeSlotContextMenuHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentContextMenu client-side event
- handler is called when an empty time slot has been right-clicked.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with four properties:
-
- get_targetSlot(), the target slot.
- get_time(), the time that corresponds to the slot.
- get_isAllDay(), a boolean indicating if this is an all-day slot (the time should be discarded in this case).
- get_domEvent(), the original DOM event.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the scheduler is about to request appointments from the Web Service.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentsPopulatingHandler(sender, eventArgs)
- {
- alert("Data loading");
- eventArgs.get_schedulerInfo().CustomProperty = "My Data";
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentsPopulating="clientAppointmentsPopulatingHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentsPopulating client-side event
- handler is called when the scheduler is about to request appointments.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised before
- the appointments are retrieved from the data service.
- The event will be raised again each time new data is about to be retrieved from the web service.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the scheduler has received appointments from the Web Service.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentsPopulatedHandler(sender)
- {
- alert("Appointments populated");
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentsPopulated="clientAppointmentsPopulatedHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentsPopulated client-side event
- handler is called when the scheduler has received appointments.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised after
- the appointments are retrieved from the data service.
- The event will be raised again each time new data has been retrieved from the web service.
- One parameter is passed to the handler:
-
- sender, the scheduler client object;
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment is received from the Web Service and is about to be rendered.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentDataBoundHandler(sender, eventArgs)
- {
- alert("Appointment loaded");
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentDataBound="clientAppointmentDataBoundHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentDataBound client-side event
- handler is called when an appointment is received and is about to be rendered.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised after
- the appointments are retrieved from the data service.
- The event will be raised for each appointment that has been retrieved from the web service.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the instance of the appointment;
- get_data(), the original data object retrieved from the web service.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment has been serialized to a data object and is about to be sent to the Web Service.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentSerializedHandler(sender, eventArgs)
- {
- eventArgs.get_data().myProperty = 1234;
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentSerialized="clientAppointmentSerializedHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentSerialized client-side event
- handler is called when an appointment has been serialized to a data object and
- is about to be sent to the Web Service.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised before
- the appointment is sent to the data service.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the instance of the appointment;
- get_data(), the constructed data object that will be sent to the web service.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment is received from the Web Service and hase been rendered.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentCreatedHandler(sender, eventArgs)
- {
- eventArgs.get_appointment().get_element().style.border = "1px solid red";
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentCreated="clientAppointmentCreatedHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentCreated client-side event
- handler is called when an appointment is received and has been rendered.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised after
- the appointments are retrieved from the data service.
- The event will be raised for each appointment that has been retrieved from the web service.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with one property:
-
- get_appointment(), the appointment that has been rendered.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the scheduler is about to request resources from the Web Service.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientResourcesPopulatingHandler(sender, eventArgs)
- {
- alert("Resources loading");
- eventArgs.get_schedulerInfo().CustomProperty = "My Data";
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientResourcesPopulating="clientResourcesPopulatingHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientResourcesPopulating client-side event
- handler is called when the scheduler is about to request resources.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised before
- the resources are retrieved from the data service.
- The event will be raised only once, at the time of the initial load.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the scheduler has received resources from the Web Service.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientResourcesPopulatedHandler(sender)
- {
- alert("Resources loaded");
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientResourcesPopulated="clientResourcesPopulatedHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientResourcesPopulated client-side event
- handler is called when the scheduler has received resources.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised after
- the resources have been retrieved from the data service.
- The event will be raised only once, at the time of the initial load.
- One parameter is passed to the handler:
-
- sender, the scheduler client object;
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the scheduler has been populated with data.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientDataBoundHandler(sender, eventArgs)
- {
- alert("Data loaded");
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientDataBound="clientDataBoundHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientDataBound client-side event
- handler is called when the scheduler has been populated with data.
- In the case of server-side binding, the event will be raised
- immediately after the control is initialized.
- When client-side binding is used, the event will be raised when
- both the appointments and the resources are retrieved from the data service.
- The event will be raised again each time new data is retrieved from the web service.
- One parameter is passed to the handler:
-
- sender, the scheduler client object;
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a request to the Web Service has succeeded.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientRequestSuccessHandler(sender, eventArgs)
- {
- alert("Operation code: " + eventArgs.get_result().Code);
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientRequestSuccess="clientRequestSuccessHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientRequestSuccess client-side event
- handler is called when a request to the Web Service has succeeded.
- In the case of server-side binding, the event will not be raised.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with one property:
-
- get_result(), the object received from the server as.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a request to the Web Service has failed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientRequestFailedHandler(sender, eventArgs)
- {
- alert("Request failed!");
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientRequestFailed="clientRequestFailedHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientRequestFailed client-side event
- handler is called when a request to the Web Service has failed.
- In the case of server-side binding, the event will not be raised.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_errorMessage(), the error message sent from the server.
- set_cancel(), set to true to suppress the default action (alert message).
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment is about to be stored via Web Service call.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentWebServiceInserting(sender, eventArgs)
- {
- alert("Insert cancelled");
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentWebServiceInserting="clientAppointmentWebServiceInserting">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentWebServiceInserting client-side event
- handler is called when an appointment is about to be stored via Web Service call.
- In the case of server-side binding, the event will not be raised.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the appointment that is about to be inserted.
- set_cancel(), set to true cancel the operation.
- get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment is about to be deleted via Web Service call.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentWebServiceDeleting(sender, eventArgs)
- {
- alert("Delete cancelled");
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentWebServiceDeleting="clientAppointmentWebServiceDeleting">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentWebServiceDeleting client-side event
- handler is called when an appointment is about to be deleted via Web Service call.
- In the case of server-side binding, the event will not be raised.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with three properties:
-
- get_appointment(), the appointment that is about to be deleted.
- get_editingRecurringSeries(), indicates whether the recurring series are being deleted.
- set_cancel(), set to true cancel the operation.
- get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an appointment is about to be updated via Web Service call.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientAppointmentWebServiceUpdating(sender, eventArgs)
- {
- alert("Update cancelled");
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentWebServiceUpdating="clientAppointmentWebServiceUpdating">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentWebServiceUpdating client-side event
- handler is called when an appointment is about to be updated via Web Service call.
- In the case of server-side binding, the event will not be raised.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the appointment that is about to be updated.
- set_cancel(), set to true cancel the operation.
- get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a recurrence exception is about to be created via Web Service call.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientRecurrenceExceptionCreating(sender, eventArgs)
- {
- alert("Operation cancelled");
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientRecurrenceExceptionCreating="clientRecurrenceExceptionCreating">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientRecurrenceExceptionCreating client-side event
- handler is called when a recurrence exception is about to be created via Web Service call.
- In the case of server-side binding, the event will not be raised.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the appointment that represents the recurrence exception that is about to be stored.
- set_cancel(), set to true cancel the operation.
- get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- recurrence exceptions are about to be removed via Web Service call.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientRecurrenceExceptionsRemoving(sender, eventArgs)
- {
- alert("Operation cancelled");
- eventArgs.set_cancel(true);
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientRecurrenceExceptionsRemoving="clientRecurrenceExceptionsRemoving">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientRecurrenceExceptionsRemoving client-side event
- handler is called when recurrence exceptions are about to be removed via Web Service call.
- In the case of server-side binding, the event will not be raised.
- When client-side binding is used, the event will be raised when the user
- chooses to remove the recurrence exceptions of a given series through the advanced form.
-
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the master appointment that represents the recurrence series.
- set_cancel(), set to true cancel the operation.
- get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the scheduler is about to execute a navigation command.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientNavigationCommandHandler(sender, eventArgs)
- {
- if (eventArgs.get_command() == Telerik.Web.UI.SchedulerNavigationCommand.NavigateToNextPeriod)
- alert("Navigating to next period");
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientNavigationCommand="clientNavigationCommandHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientNavigationCommand client-side event
- handler is called when the scheduler is about to execute a navigation command.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_command(), the navigation command that is being processed.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a navigation command has been completed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function clientNavigationCompleteHandler(sender)
- {
- if (eventArgs.get_command() == Telerik.Web.UI.SchedulerNavigationCommand.SwitchToDayView)
- alert("Displaying day view");
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnNavigationComplete="clientNavigationCompleteHandler">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnNavigationComplete client-side event
- handler is called when a navigation command has been completed.
- The event will be raised only when client-side binding is used.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with one properties:
-
- get_command(), the navigation command that is being processed.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an apointment context menu item is clicked, before RadScheduler processes the click event.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function appointmentContextMenuItemClicking(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- var clickedItem = eventArgs.get_item();
- // ...
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentContextMenuItemClicking="appointmentContextMenuItemClicking">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentContextMenuItemClicking
- client-side event handler is called when an apointment context menu item is clicked,
- before RadScheduler processes the click event.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with three properties:
-
- get_appointment(), the instance of the appointment.
- get_item(), the clicked menu item.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled. Cancelling it will prevent any further processing of the command.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- an apointment context menu item is clicked, after RadScheduler has processed the event.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function appointmentContextMenuItemClicked(sender, eventArgs)
- {
- var appointment = eventArgs.get_appointment();
- var clickedItem = eventArgs.get_item();
- // ...
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientAppointmentContextMenuItemClicked="appointmentContextMenuItemClicked">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientAppointmentContextMenuItemClicking
- client-side event handler is called when an apointment context menu item is clicked,
- after RadScheduler has processed the event.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_appointment(), the instance of the appointment.
- get_item(), the clicked menu item.
-
-
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a time slot context menu item is clicked, before RadScheduler processes the click event.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function appointmentTimeSlotMenuItemClicking(sender, eventArgs)
- {
- var timeSlot = eventArgs.get_slot();
- var clickedItem = eventArgs.get_item();
- // ...
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientTimeSlotContextMenuItemClicking="appointmentTimeSlotMenuItemClicking">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientTimeSlotContextMenuItemClicking
- client-side event handler is called when a time slot context menu item is clicked,
- before RadScheduler processes the click event.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with three properties:
-
- get_slot(), the instance of the time slot.
- get_item(), the clicked menu item.
- set_cancel(), used to cancel the event.
-
-
-
- This event can be cancelled. Cancelling it will prevent any further processing of the command.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a time slot context menu item is clicked, after RadScheduler has processed the event.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function appointmentTimeSlotMenuItemClicked(sender, eventArgs)
- {
- var timeSlot = eventArgs.get_slot();
- var clickedItem = eventArgs.get_item();
- // ...
- }
- </script>
- <telerik:RadScheduler ID="RadScheduler1"
- runat="server"
- OnClientTimeSlotContextMenuItemClicked="appointmentTimeSlotMenuItemClicked">
- ....
- </telerik:RadScheduler>
-
-
- If specified, the OnClientTimeSlotContextMenuItemClicking
- client-side event handler is called when a time slot context menu item is clicked,
- after RadScheduler has processed the event.
- Two parameters are passed to the handler:
-
- sender, the scheduler client object;
- eventArgs with two properties:
-
- get_slot(), the instance of the time slot.
- get_item(), the clicked menu item.
-
-
-
- This event cannot be cancelled.
-
-
-
- Occurrences of this rule repeat on a daily basis.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class DailyRecurrenceRuleExample1
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every two days.
- DailyRecurrenceRule rrule = new DailyRecurrenceRule(2, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek);
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM (Friday)
- 2: 6/3/2007 3:30:00 PM (Sunday)
- 3: 6/5/2007 3:30:00 PM (Tuesday)
- 4: 6/7/2007 3:30:00 PM (Thursday)
- 5: 6/9/2007 3:30:00 PM (Saturday)
- 6: 6/11/2007 3:30:00 PM (Monday)
- 7: 6/13/2007 3:30:00 PM (Wednesday)
- 8: 6/15/2007 3:30:00 PM (Friday)
- 9: 6/17/2007 3:30:00 PM (Sunday)
- 10: 6/19/2007 3:30:00 PM (Tuesday)
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class DailyRecurrenceRuleExample1
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every two days.
- Dim rrule As New DailyRecurrenceRule(2, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek)
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM (Friday)
- ' 2: 6/3/2007 3:30:00 PM (Sunday)
- ' 3: 6/5/2007 3:30:00 PM (Tuesday)
- ' 4: 6/7/2007 3:30:00 PM (Thursday)
- ' 5: 6/9/2007 3:30:00 PM (Saturday)
- ' 6: 6/11/2007 3:30:00 PM (Monday)
- ' 7: 6/13/2007 3:30:00 PM (Wednesday)
- ' 8: 6/15/2007 3:30:00 PM (Friday)
- ' 9: 6/17/2007 3:30:00 PM (Sunday)
- '10: 6/19/2007 3:30:00 PM (Tuesday)
- '
-
-
-
-
- Provides the abstract base class for recurrence rules.
- HourlyRecurrenceRule Class
- DailyRecurrenceRule Class
- WeeklyRecurrenceRule Class
- MonthlyRecurrenceRule Class
- YearlyRecurrenceRule Class
-
- Notes to implementers: This base class is provided to make it
- easier for implementers to create a recurrence rule. Implementers are encouraged to
- extend this base class instead of creating their own.
-
-
-
-
- Represents an empty recurrence rule
-
-
-
-
- Creates a recurrence rule with the specified pattern and range.
-
- The recurrence pattern.
- The recurrence range.
- The constructed recurrence rule.
-
-
- Creates a recurrence rule instance from it's string representation.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class ParsingExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every 2 hours.
- HourlyRecurrenceRule rrule = new HourlyRecurrenceRule(2, range);
-
- // Prints the string representation of the recurrence rule:
- string rruleAsString = rrule.ToString();
- Console.WriteLine("Recurrence rule:\n\n{0}\n", rruleAsString);
-
- // The string representation can be stored in a database, etc.
- // ...
-
- // Then it can be reconstructed using TryParse method:
- RecurrenceRule parsedRule;
- RecurrenceRule.TryParse(rruleAsString, out parsedRule);
- Console.WriteLine("After parsing (should be the same):\n\n{0}", parsedRule);
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Recurrence rule:
-
- DTSTART:20070601T123000Z
- DTEND:20070601T130000Z
- RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
-
-
- After parsing (should be the same):
-
- DTSTART:20070601T123000Z
- DTEND:20070601T130000Z
- RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class ParsingExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every 2 hours.
- Dim rrule As New HourlyRecurrenceRule(2, range)
-
- ' Prints the string representation of the recurrence rule:
- Dim rruleAsString As String = rrule.ToString()
- Console.WriteLine("Recurrence rule:" & Chr(10) & "" & Chr(10) & "{0}" & Chr(10) & "", rruleAsString)
-
- ' The string representation can be stored in a database, etc.
- ' ...
-
- ' Then it can be reconstructed using TryParse method:
- Dim parsedRule As RecurrenceRule
- RecurrenceRule.TryParse(rruleAsString, parsedRule)
- Console.WriteLine("After parsing (should be the same):" & Chr(10) & "" & Chr(10) & "{0}", parsedRule)
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Recurrence rule:
- '
- 'DTSTART:20070601T123000Z
- 'DTEND:20070601T130000Z
- 'RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
- '
- '
- 'After parsing (should be the same):
- '
- 'DTSTART:20070601T123000Z
- 'DTEND:20070601T130000Z
- 'RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
- '
-
-
- True if input was converted successfully, false otherwise.
- The string representation to parse.
-
- When this method returns, contains the recurrence rule instance, if the
- conversion succeeded, or null if the conversion failed. The conversion fails if the
- value parameter is a null reference (Nothing in Visual Basic)
- or represents invalid recurrence rule.
-
-
-
- Specifies the effective range for evaluating occurrences.
- End date is before Start date.
-
- The range is inclusive. To clear the effective range call
- .
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class EffectiveRangeExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every 2 hours.
- HourlyRecurrenceRule rrule = new HourlyRecurrenceRule(2, range);
-
- // Limits the effective range.
- rrule.SetEffectiveRange(Convert.ToDateTime("6/1/2007 5:00 PM"), Convert.ToDateTime("6/1/2007 8:00 PM"));
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 5:30:00 PM
- 2: 6/1/2007 7:30:00 PM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class EffectiveRangeExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every 2 hours.
- Dim rrule As New HourlyRecurrenceRule(2, range)
-
- ' Limits the effective range.
- rrule.SetEffectiveRange(Convert.ToDateTime("6/1/2007 5:00 PM"), Convert.ToDateTime("6/1/2007 8:00 PM"))
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 5:30:00 PM
- ' 2: 6/1/2007 7:30:00 PM
- '
-
-
- ClearEffectiveRange Method
- The starting date of the effective range.
- The ending date of the effective range.
-
-
- Clears the effective range set by calling .
- If no effective range was set, calling this method has no effect.
- SetEffectiveRange Method
-
-
- Converts the recurrence rule to it's equivalent string representation.
- The string representation of this recurrence rule.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class ParsingExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every 2 hours.
- HourlyRecurrenceRule rrule = new HourlyRecurrenceRule(2, range);
-
- // Prints the string representation of the recurrence rule:
- string rruleAsString = rrule.ToString();
- Console.WriteLine("Recurrence rule:\n\n{0}\n", rruleAsString);
-
- // The string representation can be stored in a database, etc.
- // ...
-
- // Then it can be reconstructed using TryParse method:
- RecurrenceRule parsedRule;
- RecurrenceRule.TryParse(rruleAsString, out parsedRule);
- Console.WriteLine("After parsing (should be the same):\n\n{0}", parsedRule);
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Recurrence rule:
-
- DTSTART:20070601T123000Z
- DTEND:20070601T130000Z
- RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
-
-
- After parsing (should be the same):
-
- DTSTART:20070601T123000Z
- DTEND:20070601T130000Z
- RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class ParsingExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every 2 hours.
- Dim rrule As New HourlyRecurrenceRule(2, range)
-
- ' Prints the string representation of the recurrence rule:
- Dim rruleAsString As String = rrule.ToString()
- Console.WriteLine("Recurrence rule:" & Chr(10) & "" & Chr(10) & "{0}" & Chr(10) & "", rruleAsString)
-
- ' The string representation can be stored in a database, etc.
- ' ...
-
- ' Then it can be reconstructed using TryParse method:
- Dim parsedRule As RecurrenceRule
- RecurrenceRule.TryParse(rruleAsString, parsedRule)
- Console.WriteLine("After parsing (should be the same):" & Chr(10) & "" & Chr(10) & "{0}", parsedRule)
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Recurrence rule:
- '
- 'DTSTART:20070601T123000Z
- 'DTEND:20070601T130000Z
- 'RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
- '
- '
- 'After parsing (should be the same):
- '
- 'DTSTART:20070601T123000Z
- 'DTEND:20070601T130000Z
- 'RRULE:FREQ=HOURLY;COUNT=10;INTERVAL=2;
- '
-
-
-
- The string representation is based on the iCalendar data format (RFC
- 2445).
-
-
-
- Overriden. Returns the hash code for this instance.
- The hash code for this instance.
-
-
-
- Overloaded. Overridden. Returns a value indicating whether this instance is equal
- to a specified object.
-
-
- true if value is an instance of
- and equals the value of this instance;
- otherwise, false.
-
- An object to compare with this instance.
-
-
-
- Overloaded. Overridden. Returns a value indicating whether this instance is equal
- to a specified object.
-
-
- true if value equals the value of this instance;
- otherwise, false.
-
- An object to compare with this instance.
-
-
-
- Determines whether two specified objects have the
- same value.
-
-
-
-
- Determines whether two specified objects have
- different values.
-
-
-
-
- Populates a SerializationInfo with the data needed to serialize this
- object.
-
- The to populate with data.
- The destination (see ) for this serialization.
-
-
- Gets the associated with this recurrence rule.
- The associated with this recurrence rule.
-
- By calling the range of the generated
- occurrences can be narrowed.
-
-
-
- Gets the associated with this recurrence rule.
- The associated with this recurrence rule.
-
-
- Occurrence times are in UTC.
- Gets the evaluated occurrence times of this recurrence rule.
- The evaluated occurrence times of this recurrence rule.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class HourlyRecurrenceRuleExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every 2 hours.
- HourlyRecurrenceRule rrule = new HourlyRecurrenceRule(2, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM
- 2: 6/1/2007 5:30:00 PM
- 3: 6/1/2007 7:30:00 PM
- 4: 6/1/2007 9:30:00 PM
- 5: 6/1/2007 11:30:00 PM
- 6: 6/2/2007 1:30:00 AM
- 7: 6/2/2007 3:30:00 AM
- 8: 6/2/2007 5:30:00 AM
- 9: 6/2/2007 7:30:00 AM
- 10: 6/2/2007 9:30:00 AM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class HourlyRecurrenceRuleExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every 2 hours.
- Dim rrule As New HourlyRecurrenceRule(2, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM
- ' 2: 6/1/2007 5:30:00 PM
- ' 3: 6/1/2007 7:30:00 PM
- ' 4: 6/1/2007 9:30:00 PM
- ' 5: 6/1/2007 11:30:00 PM
- ' 6: 6/2/2007 1:30:00 AM
- ' 7: 6/2/2007 3:30:00 AM
- ' 8: 6/2/2007 5:30:00 AM
- ' 9: 6/2/2007 7:30:00 AM
- '10: 6/2/2007 9:30:00 AM
- '
-
-
-
-
-
- Gets a value indicating whether this recurrence rule yields any
- occurrences.
-
- True this recurrence rule yields any occurrences, false otherwise.
-
-
- Gets or sets a list of the exception dates associated with this recurrence rule.
- A list of the exception dates associated with this recurrence rule.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class RecurrenceExceptionsExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every 2 hours.
- HourlyRecurrenceRule rrule = new HourlyRecurrenceRule(2, range);
-
- // Creates a recurrence exception for 5:30 PM (local time).
- // Note that exception dates must be in universal time.
- rrule.Exceptions.Add(Convert.ToDateTime("6/1/2007 5:30 PM").ToUniversalTime());
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM
- 2: 6/1/2007 7:30:00 PM
- 3: 6/1/2007 9:30:00 PM
- 4: 6/1/2007 11:30:00 PM
- 5: 6/2/2007 1:30:00 AM
- 6: 6/2/2007 3:30:00 AM
- 7: 6/2/2007 5:30:00 AM
- 8: 6/2/2007 7:30:00 AM
- 9: 6/2/2007 9:30:00 AM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class RecurrenceExceptionsExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every 2 hours.
- Dim rrule As New HourlyRecurrenceRule(2, range)
-
- ' Creates a recurrence exception for 5:30 PM (local time).
- ' Note that exception dates must be in universal time.
- rrule.Exceptions.Add(Convert.ToDateTime("6/1/2007 5:30 PM").ToUniversalTime())
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM
- ' 2: 6/1/2007 7:30:00 PM
- ' 3: 6/1/2007 9:30:00 PM
- ' 4: 6/1/2007 11:30:00 PM
- ' 5: 6/2/2007 1:30:00 AM
- ' 6: 6/2/2007 3:30:00 AM
- ' 7: 6/2/2007 5:30:00 AM
- ' 8: 6/2/2007 7:30:00 AM
- ' 9: 6/2/2007 9:30:00 AM
- '
-
-
-
- Any date placed in the list will be considered a recurrence exception, i.e. an
- occurrence will not be generated for that date. The dates must be in universal
- time.
-
-
-
-
- Gets a value indicating whether this recurrence rule has associated
- exceptions.
-
- True if this recurrence rule has associated exceptions, false otherwise.
-
-
-
- Gets or sets the maximum candidates limit.
-
-
- This limit is used to prevent lockups when evaluating infinite rules without using SetEffectiveRange.
- The default value should not be changed under normal conditions.
-
- The maximum candidates limit.
-
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class DailyRecurrenceRuleExample1
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every two days.
- DailyRecurrenceRule rrule = new DailyRecurrenceRule(2, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek);
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM (Friday)
- 2: 6/3/2007 3:30:00 PM (Sunday)
- 3: 6/5/2007 3:30:00 PM (Tuesday)
- 4: 6/7/2007 3:30:00 PM (Thursday)
- 5: 6/9/2007 3:30:00 PM (Saturday)
- 6: 6/11/2007 3:30:00 PM (Monday)
- 7: 6/13/2007 3:30:00 PM (Wednesday)
- 8: 6/15/2007 3:30:00 PM (Friday)
- 9: 6/17/2007 3:30:00 PM (Sunday)
- 10: 6/19/2007 3:30:00 PM (Tuesday)
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class DailyRecurrenceRuleExample1
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every two days.
- Dim rrule As New DailyRecurrenceRule(2, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek)
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM (Friday)
- ' 2: 6/3/2007 3:30:00 PM (Sunday)
- ' 3: 6/5/2007 3:30:00 PM (Tuesday)
- ' 4: 6/7/2007 3:30:00 PM (Thursday)
- ' 5: 6/9/2007 3:30:00 PM (Saturday)
- ' 6: 6/11/2007 3:30:00 PM (Monday)
- ' 7: 6/13/2007 3:30:00 PM (Wednesday)
- ' 8: 6/15/2007 3:30:00 PM (Friday)
- ' 9: 6/17/2007 3:30:00 PM (Sunday)
- '10: 6/19/2007 3:30:00 PM (Tuesday)
- '
-
-
-
- Initializes a new instance of with the
- specified interval (in days) and .
-
- The number of days between the occurrences.
-
- The instance that specifies the range of this
- recurrence rule.
-
-
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class DailyRecurrenceRuleExample2
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every week day.
- DailyRecurrenceRule rrule = new DailyRecurrenceRule(RecurrenceDay.WeekDays, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek);
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM (Friday)
- 2: 6/4/2007 3:30:00 PM (Monday)
- 3: 6/5/2007 3:30:00 PM (Tuesday)
- 4: 6/6/2007 3:30:00 PM (Wednesday)
- 5: 6/7/2007 3:30:00 PM (Thursday)
- 6: 6/8/2007 3:30:00 PM (Friday)
- 7: 6/11/2007 3:30:00 PM (Monday)
- 8: 6/12/2007 3:30:00 PM (Tuesday)
- 9: 6/13/2007 3:30:00 PM (Wednesday)
- 10: 6/14/2007 3:30:00 PM (Thursday)
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class DailyRecurrenceRuleExample2
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every week day.
- Dim rrule As New DailyRecurrenceRule(RecurrenceDay.WeekDays, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek)
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM (Friday)
- ' 2: 6/4/2007 3:30:00 PM (Monday)
- ' 3: 6/5/2007 3:30:00 PM (Tuesday)
- ' 4: 6/6/2007 3:30:00 PM (Wednesday)
- ' 5: 6/7/2007 3:30:00 PM (Thursday)
- ' 6: 6/8/2007 3:30:00 PM (Friday)
- ' 7: 6/11/2007 3:30:00 PM (Monday)
- ' 8: 6/12/2007 3:30:00 PM (Tuesday)
- ' 9: 6/13/2007 3:30:00 PM (Wednesday)
- '10: 6/14/2007 3:30:00 PM (Thursday)
- '
-
-
-
- Initializes a new instance of with the
- specified days of week bit mask and .
-
- A bit mask that specifies the week days on which the event recurs.
-
- The instance that specifies the range of this
- recurrence rule.
-
-
-
- Gets the interval (in days) between the occurrences.
- The interval (in days) between the occurrences.
-
-
-
- Gets or sets the bit mask that specifies the week days on which the event
- recurs.
-
- RecurrenceDay Enumeration
-
- For additional information on how to create masks see the
- documentation.
-
- A bit mask that specifies the week days on which the event recurs.
-
-
- Occurrences of this rule repeat every given number of hours.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class HourlyRecurrenceRuleExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every 2 hours.
- HourlyRecurrenceRule rrule = new HourlyRecurrenceRule(2, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM
- 2: 6/1/2007 5:30:00 PM
- 3: 6/1/2007 7:30:00 PM
- 4: 6/1/2007 9:30:00 PM
- 5: 6/1/2007 11:30:00 PM
- 6: 6/2/2007 1:30:00 AM
- 7: 6/2/2007 3:30:00 AM
- 8: 6/2/2007 5:30:00 AM
- 9: 6/2/2007 7:30:00 AM
- 10: 6/2/2007 9:30:00 AM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class HourlyRecurrenceRuleExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every 2 hours.
- Dim rrule As New HourlyRecurrenceRule(2, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM
- ' 2: 6/1/2007 5:30:00 PM
- ' 3: 6/1/2007 7:30:00 PM
- ' 4: 6/1/2007 9:30:00 PM
- ' 5: 6/1/2007 11:30:00 PM
- ' 6: 6/2/2007 1:30:00 AM
- ' 7: 6/2/2007 3:30:00 AM
- ' 8: 6/2/2007 5:30:00 AM
- ' 9: 6/2/2007 7:30:00 AM
- '10: 6/2/2007 9:30:00 AM
- '
-
-
-
-
-
- Initializes a new instance of the class
- with the specified interval (in hours) and .
-
- The number of hours between the occurrences.
-
- The instance that specifies the range of this
- recurrence rule.
-
-
-
- Gets the interval (in hours) assigned to the current instance.
- The interval (in hours) assigned to the current instance.
-
-
-
- Occurrences of this rule repeat on a monthly basis.
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class MonthlyRecurrenceRuleExample1
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 5;
-
- // Creates a recurrence rule to repeat the appointment on the 5th day of every month.
- MonthlyRecurrenceRule rrule = new MonthlyRecurrenceRule(5, 1, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/5/2007 3:30:00 PM
- 2: 7/5/2007 3:30:00 PM
- 3: 8/5/2007 3:30:00 PM
- 4: 9/5/2007 3:30:00 PM
- 5: 10/5/2007 3:30:00 PM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class MonthlyRecurrenceRuleExample1
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 5
-
- ' Creates a recurrence rule to repeat the appointment on the 5th day of every month.
- Dim rrule As New MonthlyRecurrenceRule(5, 1, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/5/2007 3:30:00 PM
- ' 2: 7/5/2007 3:30:00 PM
- ' 3: 8/5/2007 3:30:00 PM
- ' 4: 9/5/2007 3:30:00 PM
- ' 5: 10/5/2007 3:30:00 PM
- '
-
-
-
-
-
- Initializes a new instance of the class.
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class MonthlyRecurrenceRuleExample1
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 5;
-
- // Creates a recurrence rule to repeat the appointment on the 5th day of every month.
- MonthlyRecurrenceRule rrule = new MonthlyRecurrenceRule(5, 1, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/5/2007 3:30:00 PM
- 2: 7/5/2007 3:30:00 PM
- 3: 8/5/2007 3:30:00 PM
- 4: 9/5/2007 3:30:00 PM
- 5: 10/5/2007 3:30:00 PM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class MonthlyRecurrenceRuleExample1
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 5
-
- ' Creates a recurrence rule to repeat the appointment on the 5th day of every month.
- Dim rrule As New MonthlyRecurrenceRule(5, 1, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/5/2007 3:30:00 PM
- ' 2: 7/5/2007 3:30:00 PM
- ' 3: 8/5/2007 3:30:00 PM
- ' 4: 9/5/2007 3:30:00 PM
- ' 5: 10/5/2007 3:30:00 PM
- '
-
-
- The day of month on which the event recurs.
- The interval (in months) between the occurrences.
- The instance that specifies the range of this rule.
-
-
-
- Initializes a new instance of the class.
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class MonthlyRecurrenceRuleExample2
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 5;
-
- // Creates a recurrence rule to repeat the appointment on the last monday of every two months.
- MonthlyRecurrenceRule rrule = new MonthlyRecurrenceRule(-1, RecurrenceDay.Monday, 2, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/25/2007 3:30:00 PM
- 2: 8/27/2007 3:30:00 PM
- 3: 10/29/2007 2:30:00 PM
- 4: 12/31/2007 2:30:00 PM
- 5: 2/25/2008 2:30:00 PM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class MonthlyRecurrenceRuleExample2
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 5
-
- ' Creates a recurrence rule to repeat the appointment on the last monday of every two months.
- Dim rrule As New MonthlyRecurrenceRule(-1, RecurrenceDay.Monday, 2, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/25/2007 3:30:00 PM
- ' 2: 8/27/2007 3:30:00 PM
- ' 3: 10/29/2007 2:30:00 PM
- ' 4: 12/31/2007 2:30:00 PM
- ' 5: 2/25/2008 2:30:00 PM
- '
-
-
- The day ordinal modifier. See for additional information.
- A bit mask that specifies the week days on which the event recurs.
- The interval (in months) between the occurrences.
- The instance that specifies the range of this rule.
-
-
-
- Gets the day of month on which the event recurs.
-
- The day of month on which the event recurs.
-
-
-
- Gets the day ordinal modifier. See for additional information.
-
-
- The day ordinal modifier.
-
-
-
- Gets the month in which the event recurs.
-
- The month in which the event recurs.
-
-
- Gets the interval (in months) between the occurrences.
- The interval (in months) between the occurrences.
-
-
-
- Specifies the days of the week. Members might be combined using bitwise
- operations to specify multiple days.
-
-
- The constants in the enumeration might be combined
- with bitwise operations to represent any combination of days. It is designed to be
- used in conjunction with the class to filter
- the days of the week for which the recurrence pattern applies.
-
-
- Consider the following example that demonstrates the basic usage pattern of
- RecurrenceDay. The most common operators used for manipulating bit fields
- are:
-
- Bitwise OR: Turns a flag on.
- Bitwise XOR: Toggles a flag.
- Bitwise AND: Checks if a flag is turned on.
- Bitwise NOT: Turns a flag off.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class RecurrenceDayExample
- {
- static void Main()
- {
- // Selects Friday, Saturday and Sunday.
- RecurrenceDay dayMask = RecurrenceDay.Friday | RecurrenceDay.WeekendDays;
- PrintSelectedDays(dayMask);
-
- // Selects all days, except Thursday.
- dayMask = RecurrenceDay.EveryDay ^ RecurrenceDay.Thursday;
- PrintSelectedDays(dayMask);
- }
-
- static void PrintSelectedDays(RecurrenceDay dayMask)
- {
- Console.WriteLine("Value: {0,3} - {1}", (int) dayMask, dayMask);
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Value: 112 - Friday, WeekendDays
- Value: 119 - Monday, Tuesday, Wednesday, Friday, WeekendDays
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class RecurrenceDayExample
- Shared Sub Main()
- ' Selects Friday, Saturday and Sunday.
- Dim dayMask As RecurrenceDay = RecurrenceDay.Friday Or RecurrenceDay.WeekendDays
- PrintSelectedDays(dayMask)
-
- ' Selects all days, except Thursday.
- dayMask = RecurrenceDay.EveryDay Xor RecurrenceDay.Thursday
- PrintSelectedDays(dayMask)
- End Sub
-
- Shared Sub PrintSelectedDays(ByVal dayMask As RecurrenceDay)
- Console.WriteLine("Value: {0,3} - {1}", DirectCast(dayMask, Integer), dayMask)
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Value: 112 - Friday, WeekendDays
- 'Value: 119 - Monday, Tuesday, Wednesday, Friday, WeekendDays
- '
-
-
-
-
- Indicates no selected day.
-
-
- Indicates Monday.
-
-
- Indicates Tuesday.
-
-
- Indicates Wednesday.
-
-
- Indicates Thursday.
-
-
- Indicates Friday.
-
-
- Indicates Saturday.
-
-
- Indicates Sunday.
-
-
- Indicates the range from Sunday to Saturday inclusive.
-
-
- Indicates the range from Monday to Friday inclusive.
-
-
- Indicates the range from Saturday to Sunday inclusive.
-
-
- Specifies the frequency of a recurrence.
-
-
- Indicates no recurrence.
-
-
- Indicates hourly recurrence.
-
-
- Indicates daily recurrence.
-
-
- Indicates weekly recurrence.
-
-
- Indicates monthly recurrence.
-
-
- Indicates yearly recurrence.
-
-
- Specifies the months in which given event recurs.
-
-
- Indicates no monthly recurrence.
-
-
- Indicates that the event recurs in January.
-
-
- Indicates that the event recurs in February.
-
-
- Indicates that the event recurs in March.
-
-
- Indicates that the event recurs in April.
-
-
- Indicates that the event recurs in May.
-
-
- Indicates that the event recurs in June.
-
-
- Indicates that the event recurs in July.
-
-
- Indicates that the event recurs in August.
-
-
- Indicates that the event recurs in September.
-
-
- Indicates that the event recurs in October.
-
-
- Indicates that the event recurs in November.
-
-
- Indicates that the event recurs in December.
-
-
-
- Specifies the pattern that uses to evaluate the
- recurrence dates set.
-
-
-
- The properties of the class work together
- to define a complete pattern definition to be used by the
- engine.
-
-
- You should not need to work with it directly as specialized
- classes are provided for the supported modes
- of recurrence. They take care of constructing appropriate
- objects.
-
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class RecurrencePatternExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule for the appointment.
- DailyRecurrenceRule rrule = new DailyRecurrenceRule(1, range);
-
- // Displays the relevant parts of the generated pattern:
- Console.WriteLine("The active recurrence pattern is:");
- Console.WriteLine(" Frequency: {0}", rrule.Pattern.Frequency);
- Console.WriteLine(" Interval: {0}", rrule.Pattern.Interval);
- Console.WriteLine(" Days of week: {0}\n", rrule.Pattern.DaysOfWeekMask);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- The active recurrence pattern is:
- Frequency: Daily
- Interval: 1
- Days of week: EveryDay
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM
- 2: 6/2/2007 3:30:00 PM
- 3: 6/3/2007 3:30:00 PM
- 4: 6/4/2007 3:30:00 PM
- 5: 6/5/2007 3:30:00 PM
- 6: 6/6/2007 3:30:00 PM
- 7: 6/7/2007 3:30:00 PM
- 8: 6/8/2007 3:30:00 PM
- 9: 6/9/2007 3:30:00 PM
- 10: 6/10/2007 3:30:00 PM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class RecurrencePatternExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule for the appointment.
- Dim rrule As New DailyRecurrenceRule(1, range)
-
- ' Displays the relevant parts of the generated pattern:
- Console.WriteLine("The active recurrence pattern is:")
- Console.WriteLine(" Frequency: {0}", rrule.Pattern.Frequency)
- Console.WriteLine(" Interval: {0}", rrule.Pattern.Interval)
- Console.WriteLine(" Days of week: {0}" & Chr(10) & "", rrule.Pattern.DaysOfWeekMask)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'The active recurrence pattern is:
- ' Frequency: Daily
- ' Interval: 1
- ' Days of week: EveryDay
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM
- ' 2: 6/2/2007 3:30:00 PM
- ' 3: 6/3/2007 3:30:00 PM
- ' 4: 6/4/2007 3:30:00 PM
- ' 5: 6/5/2007 3:30:00 PM
- ' 6: 6/6/2007 3:30:00 PM
- ' 7: 6/7/2007 3:30:00 PM
- ' 8: 6/8/2007 3:30:00 PM
- ' 9: 6/9/2007 3:30:00 PM
- '10: 6/10/2007 3:30:00 PM
- '
-
-
-
-
-
- Overloaded. Overridden. Returns a value indicating whether this instance is equal
- to a specified object.
-
-
- true if value is an instance of
- and equals the value of this instance;
- otherwise, false.
-
- An object to compare with this instance.
-
-
- Overriden. Returns the hash code for this instance.
- The hash code for this instance.
-
-
-
- Overloaded. Overridden. Returns a value indicating whether this instance is equal
- to a specified object.
-
-
- true if value equals the value of this instance;
- otherwise, false.
-
- An object to compare with this instance.
-
-
-
- Determines whether two specified objects have the
- same value.
-
-
-
-
- Determines whether two specified objects have
- different values.
-
-
-
-
-
- A enumerated constant that indicates the
- frequency of recurrence.
-
-
- Gets or sets the frequency of recurrence.
- The default value is .
- RecurrenceFrequency Enumeration
-
-
- Gets or sets the interval of recurrence.
-
-
- A positive integer representing how often the recurrence rule repeats,
- expressed in units.
-
-
- The default value is 1.
-
-
-
- Gets or sets the bit mask that specifies the week days on which the event
- recurs.
-
- RecurrenceDay Enumeration
-
- For additional information on how to create masks see the
- documentation.
-
- A bit mask that specifies the week days on which the event recurs.
-
-
- Gets or sets the day month on which the event recurs.
- The day month on which the event recurs.
-
-
-
-
- This property is meaningful only when is
- set to or
- and
- is not set.
-
- In such scenario it selects the n-th occurrence within the set of events
- specified by the rule. Valid values are from -31 to +31, 0 is ignored.
- For example with RecurrenceFrequency set to Monthly and DaysOfWeekMask set to
- Monday DayOfMonth is interpreted in the following way:
-
-
-
-
1: Selects the first monday of the month.
-
3: Selects the third monday of the month.
-
-1: Selects the last monday of the month.
-
-
-
-
- For detailed examples see the documentation of the
- class.
-
-
- MonthlyRecurrenceRule Class
-
-
- Gets or sets the month on which the event recurs.
-
- This property is only meaningful when is set
- to .
-
-
-
- Gets or sets the day on which the week starts.
-
- This property is only meaningful when is set
- to and is greater than 1.
-
-
-
-
-
- Specifies the time frame for which given is
- active. It consists of the start time of the event, it's duration and optional
- limits.
-
-
-
-
- Limits for both occurrence count and end date can be specified via the
- and
- properties.
-
-
- Start and EventDuration properties refer to the recurring event's start and
- duration. In the context of they are usually
- derived from and .
-
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class RecurrenceRangeExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a daily recurrence rule for the appointment.
- DailyRecurrenceRule rrule = new DailyRecurrenceRule(1, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/1/2007 3:30:00 PM
- 2: 6/2/2007 3:30:00 PM
- 3: 6/3/2007 3:30:00 PM
- 4: 6/4/2007 3:30:00 PM
- 5: 6/5/2007 3:30:00 PM
- 6: 6/6/2007 3:30:00 PM
- 7: 6/7/2007 3:30:00 PM
- 8: 6/8/2007 3:30:00 PM
- 9: 6/9/2007 3:30:00 PM
- 10: 6/10/2007 3:30:00 PM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class RecurrenceRangeExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a daily recurrence rule for the appointment.
- Dim rrule As New DailyRecurrenceRule(1, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/1/2007 3:30:00 PM
- ' 2: 6/2/2007 3:30:00 PM
- ' 3: 6/3/2007 3:30:00 PM
- ' 4: 6/4/2007 3:30:00 PM
- ' 5: 6/5/2007 3:30:00 PM
- ' 6: 6/6/2007 3:30:00 PM
- ' 7: 6/7/2007 3:30:00 PM
- ' 8: 6/8/2007 3:30:00 PM
- ' 9: 6/9/2007 3:30:00 PM
- '10: 6/10/2007 3:30:00 PM
- '
-
-
-
-
-
- Overloaded. Initializes a new instance of the
- class.
-
-
-
-
- Overloaded. Initializes a new instance of the
- class with to the specified Start, EventDuration, RecursUntil and MaxOccurrences
- values.
-
- The start of the recurring event.
- The duration of the recurring event.
-
- Optional end date for the recurring appointment. Defaults to no end date
- (DateTime.MaxValue).
-
-
- Optional limit for the number of occurrences. Defaults to no limit
- (Int32.MaxInt).
-
-
-
-
- Overloaded. Overridden. Returns a value indicating whether this instance is equal
- to a specified object.
-
-
- true if value is an instance of
- and equals the value of this instance;
- otherwise, false.
-
- An object to compare with this instance.
-
-
- Overriden. Returns the hash code for this instance.
-
-
-
- Overloaded. Overridden. Returns a value indicating whether this instance is equal
- to a specified object.
-
-
- true if value equals the value of this instance;
- otherwise, false.
-
- An object to compare with this instance.
-
-
-
- Determines whether two specified objects have the
- same value.
-
-
-
-
- Determines whether two specified objects have
- different values.
-
-
-
- The start of the recurring event.
-
-
- The duration of the recurring event.
-
-
-
- Optional end date for the recurring appointment. Defaults to no end date
- (DateTime.MaxValue).
-
-
-
-
- Optional limit for the number of occurrences. Defaults to no limit
- (Int32.MaxInt).
-
-
-
-
- Provides a type converter to convert RecurrenceRule objects to and from string
- representation.
-
-
-
-
- Overloaded. Returns whether this converter can convert an object of one type to
- the type of this converter.
-
-
-
-
- Overloaded. Converts the given value to the type of this converter.
-
-
-
-
- Overloaded. Returns whether this converter can convert the object to the
- specified type.
-
-
-
- Overloaded. Converts the given value object to the specified type.
-
-
- Overloaded. Returns whether the given value object is valid for this type.
-
-
- Occurrences of this rule repeat on a weekly basis.
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class WeeklyRecurrenceRuleExample
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"),
- Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 10;
-
- // Creates a recurrence rule to repeat the appointment every two weeks on Mondays and Tuesdays.
- RecurrenceDay mask = RecurrenceDay.Monday | RecurrenceDay.Tuesday;
- WeeklyRecurrenceRule rrule = new WeeklyRecurrenceRule(2, mask, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek);
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 6/4/2007 3:30:00 PM (Monday)
- 2: 6/5/2007 3:30:00 PM (Tuesday)
- 3: 6/18/2007 3:30:00 PM (Monday)
- 4: 6/19/2007 3:30:00 PM (Tuesday)
- 5: 7/2/2007 3:30:00 PM (Monday)
- 6: 7/3/2007 3:30:00 PM (Tuesday)
- 7: 7/16/2007 3:30:00 PM (Monday)
- 8: 7/17/2007 3:30:00 PM (Tuesday)
- 9: 7/30/2007 3:30:00 PM (Monday)
- 10: 7/31/2007 3:30:00 PM (Tuesday)
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class WeeklyRecurrenceRuleExample
- Shared Sub Main()
- ' Creates a sample appointment that starts at 6/1/2007 3:30 PM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("6/1/2007 3:30 PM"), Convert.ToDateTime("6/1/2007 4:00 PM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 10
-
- ' Creates a recurrence rule to repeat the appointment every two weeks on Mondays and Tuesdays.
- Dim mask As RecurrenceDay = RecurrenceDay.Monday Or RecurrenceDay.Tuesday
- Dim rrule As New WeeklyRecurrenceRule(2, mask, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1} ({2})", ix, occurrence.ToLocalTime(), occurrence.DayOfWeek)
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 6/4/2007 3:30:00 PM (Monday)
- ' 2: 6/5/2007 3:30:00 PM (Tuesday)
- ' 3: 6/18/2007 3:30:00 PM (Monday)
- ' 4: 6/19/2007 3:30:00 PM (Tuesday)
- ' 5: 7/2/2007 3:30:00 PM (Monday)
- ' 6: 7/3/2007 3:30:00 PM (Tuesday)
- ' 7: 7/16/2007 3:30:00 PM (Monday)
- ' 8: 7/17/2007 3:30:00 PM (Tuesday)
- ' 9: 7/30/2007 3:30:00 PM (Monday)
- '10: 7/31/2007 3:30:00 PM (Tuesday)
- '
-
-
-
-
-
- Initializes a new instance of with the
- specified interval, days of week bit mask and .
-
- The number of weeks between the occurrences.
- A bit mask that specifies the week days on which the event recurs.
-
- The instance that specifies the range of this rule.
-
-
-
-
- Initializes a new instance of with the
- specified interval, days of week bit mask and .
-
- The number of weeks between the occurrences.
- A bit mask that specifies the week days on which the event recurs.
-
- The instance that specifies the range of this rule.
-
-
- The first day of week to use for calculations.
-
-
-
- Gets the interval (in weeks) assigned to the current instance.
- The interval (in weeks) assigned to the current instance.
-
-
-
- Gets the bit mask that specifies the week days on which the event
- recurs.
-
- RecurrenceDay Enumeration
-
- For additional information on how to create masks see the
- documentation.
-
- A bit mask that specifies the week days on which the event recurs.
-
-
-
- Occurrences of this rule repeat on a yearly basis.
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class YearlyRecurrenceRuleExample1
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 4/1/2007 10:00 AM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("4/1/2007 10:00 AM"),
- Convert.ToDateTime("4/1/2007 10:30 AM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 5;
-
- // Creates a recurrence rule to repeat the appointment on the 1th of April each year.
- YearlyRecurrenceRule rrule = new YearlyRecurrenceRule(RecurrenceMonth.April, 1, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 4/1/2007 10:00:00 AM
- 2: 4/1/2008 10:00:00 AM
- 3: 4/1/2009 10:00:00 AM
- 4: 4/1/2010 10:00:00 AM
- 5: 4/1/2011 10:00:00 AM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class YearlyRecurrenceRuleExample1
- Shared Sub Main()
- ' Creates a sample appointment that starts at 4/1/2007 10:00 AM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("4/1/2007 10:00 AM"), Convert.ToDateTime("4/1/2007 10:30 AM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 5
-
- ' Creates a recurrence rule to repeat the appointment on the 1th of April each year.
- Dim rrule As New YearlyRecurrenceRule(RecurrenceMonth.April, 1, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 4/1/2007 10:00:00 AM
- ' 2: 4/1/2008 10:00:00 AM
- ' 3: 4/1/2009 10:00:00 AM
- ' 4: 4/1/2010 10:00:00 AM
- ' 5: 4/1/2011 10:00:00 AM
- '
-
-
-
-
-
- Initializes a new instance of the class.
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class YearlyRecurrenceRuleExample1
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 4/1/2007 10:00 AM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("4/1/2007 10:00 AM"),
- Convert.ToDateTime("4/1/2007 10:30 AM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 5;
-
- // Creates a recurrence rule to repeat the appointment on the 1th of April each year.
- YearlyRecurrenceRule rrule = new YearlyRecurrenceRule(RecurrenceMonth.April, 1, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 4/1/2007 10:00:00 AM
- 2: 4/1/2008 10:00:00 AM
- 3: 4/1/2009 10:00:00 AM
- 4: 4/1/2010 10:00:00 AM
- 5: 4/1/2011 10:00:00 AM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class YearlyRecurrenceRuleExample1
- Shared Sub Main()
- ' Creates a sample appointment that starts at 4/1/2007 10:00 AM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("4/1/2007 10:00 AM"), Convert.ToDateTime("4/1/2007 10:30 AM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 5
-
- ' Creates a recurrence rule to repeat the appointment on the 1th of April each year.
- Dim rrule As New YearlyRecurrenceRule(RecurrenceMonth.April, 1, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 4/1/2007 10:00:00 AM
- ' 2: 4/1/2008 10:00:00 AM
- ' 3: 4/1/2009 10:00:00 AM
- ' 4: 4/1/2010 10:00:00 AM
- ' 5: 4/1/2011 10:00:00 AM
- '
-
-
- The month in which the event recurs.
- The day of month on which the event recurs.
- The instance that specifies the range of this rule.
-
-
-
- Initializes a new instance of the class.
-
-
-
- using System;
- using Telerik.Web.UI;
-
- namespace RecurrenceExamples
- {
- class YearlyRecurrenceRuleExample2
- {
- static void Main()
- {
- // Creates a sample appointment that starts at 4/1/2007 10:00 AM (local time) and lasts half an hour.
- Appointment recurringAppointment = new Appointment("1", Convert.ToDateTime("4/1/2007 10:00 AM"),
- Convert.ToDateTime("4/1/2007 10:30 AM"), "Sample appointment");
-
- // Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- RecurrenceRange range = new RecurrenceRange();
- range.Start = recurringAppointment.Start;
- range.EventDuration = recurringAppointment.End - recurringAppointment.Start;
- range.MaxOccurrences = 5;
-
- // Creates a recurrence rule to repeat the appointment on the second monday of April each year.
- YearlyRecurrenceRule rrule = new YearlyRecurrenceRule(2, RecurrenceMonth.April, RecurrenceDay.Monday, range);
-
- Console.WriteLine("Appointment occurrs at the following times: ");
- int ix = 0;
- foreach (DateTime occurrence in rrule.Occurrences)
- {
- ix = ix + 1;
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime());
- }
- }
- }
- }
-
- /*
- This example produces the following results:
-
- Appointment occurrs at the following times:
- 1: 4/9/2007 10:00:00 AM
- 2: 4/14/2008 10:00:00 AM
- 3: 4/13/2009 10:00:00 AM
- 4: 4/12/2010 10:00:00 AM
- 5: 4/11/2011 10:00:00 AM
- */
-
-
- Imports System
- Imports Telerik.Web.UI
-
- Namespace RecurrenceExamples
- Class YearlyRecurrenceRuleExample2
- Shared Sub Main()
- ' Creates a sample appointment that starts at 4/1/2007 10:00 AM (local time) and lasts half an hour.
- Dim recurringAppointment As New Appointment("1", Convert.ToDateTime("4/1/2007 10:00 AM"), Convert.ToDateTime("4/1/2007 10:30 AM"), "Sample appointment")
-
- ' Creates a recurrence range, that specifies a limit of 10 occurrences for the appointment.
- Dim range As New RecurrenceRange()
- range.Start = recurringAppointment.Start
- range.EventDuration = recurringAppointment.[End] - recurringAppointment.Start
- range.MaxOccurrences = 5
-
- ' Creates a recurrence rule to repeat the appointment on the second monday of April each year.
- Dim rrule As New YearlyRecurrenceRule(2, RecurrenceMonth.April, RecurrenceDay.Monday, range)
-
- Console.WriteLine("Appointment occurrs at the following times: ")
- Dim ix As Integer = 0
- For Each occurrence As DateTime In rrule.Occurrences
- ix = ix + 1
- Console.WriteLine("{0,2}: {1}", ix, occurrence.ToLocalTime())
- Next
- End Sub
- End Class
- End Namespace
-
- '
- 'This example produces the following results:
- '
- 'Appointment occurrs at the following times:
- ' 1: 4/9/2007 10:00:00 AM
- ' 2: 4/14/2008 10:00:00 AM
- ' 3: 4/13/2009 10:00:00 AM
- ' 4: 4/12/2010 10:00:00 AM
- ' 5: 4/11/2011 10:00:00 AM
- '
-
-
- The day ordinal modifier. See for additional information.
- The month in which the event recurs.
- A bit mask that specifies the week days on which the event recurs.
- The instance that specifies the range of this rule.
-
-
-
- Gets the day of month on which the event recurs.
-
- The day of month on which the event recurs.
-
-
-
- Gets the day ordinal modifier. See for additional information.
-
- The day ordinal modifier.
-
-
-
- Gets the month in which the event recurs.
-
- The month in which the event recurs.
-
-
-
- Gets the bit mask that specifies the week days on which the event
- recurs.
-
- RecurrenceDay Enumeration
-
- For additional information on how to create masks see the
- documentation.
-
- A bit mask that specifies the week days on which the event recurs.
-
-
-
- Gets or sets a value indicating the resource primary key value.
-
-
- The resource primary key value.
-
-
-
-
- Gets or sets a value indicating the user-friendly description of the resource.
-
-
- The user-friendly description of the resource.
-
-
-
-
- Gets or sets a value indicating the resource type.
-
-
- The resource type.
-
-
- The type must be one of the described resource types in
- ResourceTypes collection.
-
-
-
-
- Gets or sets a value indicating if the resource is a available.
-
-
- A value indicating if the resource is a available.
-
-
- Resources marked as unavailable will not be visible
- in the drop-down lists in the advanced form (if applicable).
-
-
-
-
- Gets or sets the cascading style sheet (CSS) class rendered for appointments that use this resource.
-
-
- The cascading style sheet (CSS) class rendered for appointments that use this resource.
- The default value is Empty.
-
-
- You can define your own CSS class name or use some of the predefined class names:
-
- rsCategoryRed
- rsCategoryBlue
- rsCategoryOrange
- rsCategoryGreen
-
-
-
-
-
- Gets the collection of arbitrary attributes that do not correspond to properties on the resource.
-
-
- A System.Web.UI.AttributeCollection of name and value pairs.
-
-
-
-
- Gets or sets the data item represented by the
- Resource object in the
- RadScheduler control.
-
-
- This property is available only during data binding.
-
-
-
-
- Gets the first resource (if any) of the specified type.
-
- The type of resource to search for.
- The first resource of the specified type; null if no resource matches.
-
-
-
- Gets the resources of the specified type.
-
- The type of resource to search for.
- The resources of the specified type.
-
-
-
- Gets the resource that matches the specified type and key.
-
- The type.
- The key.
- The resource that matches the specified type and key; null if no resource matches.
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Represents a directory item in the FileBrowser control.
-
-
-
-
- The base class of the FileItem and DirectoryItem classes. Contains the common functionality.
-
-
-
-
- Serializes the item into a javascript array. This method should be overriden only when developing
- a custom FileBrowser control.
-
- a StringWriter used as a target for the serialization.
-
-
-
- Utility method used when serializing. Escapes a string for javascript.
-
-
-
-
- Utility method used when serializing. Writes a javascript array separator.
-
-
-
-
- Utility method used when serializing. Removes the last javascript array separator from the underlying
- StringBuilder of writer.
-
-
-
-
- Serializes the Attributes array.
-
-
-
-
-
- Gets or sets a string array containing custom values which can be used on the client when
- customizing the FileBrowser control.
-
-
-
-
- Gets the full virtual path to the file/directory item.
-
-
-
-
- Gets the name of the file item. The value of this property will be displayed in the FileBrowser control.
-
-
-
-
- Gets the permissions on the file item.
-
-
-
-
- Gets the tag of the file/directory item. Used in custom content providers (can store additional data).
-
-
-
-
- Clears the Directories array. Can be used when building the directory list in List mode.
-
-
-
-
- Serializes the directory item into a javascript array. This method should be overriden only when developing
- a custom FileBrowser control.
-
- a StringWriter used as a target for the serialization.
-
-
-
- Serializes the children of the directory item as a javascript array.
- Recursively calls the Serialize methods of all child objects.
-
- a StringWriter used as a target for the serialization.
-
-
-
- Creates an instance of the DirectoryItem class.
-
-
-
-
- Creates an instance of the DirectoryItem class.
-
- The name of the directory item.
- The location of the directory item. To let the FileBrowser control
- automatically build its path you should set this parameter to string.Empty. If the DirectoryItem is a
- root item, this parameter must contain the virtual location of the item.
- The full virtual path of the directory item. Used by the ContentProvider for
- populating the Directories and Files properties.
- The tag of the directory item. Used when the virtual path must be different than the url of the item.
- When the value of this property is set, the FileBrowser control uses it instead of the combined virtual path.
- The permissions for this directory item.
- A FileItem array containing all child file items.
- A DirectoryItem array containing all child directory items.
-
-
-
- Gets the full virtual path to the directory item.
-
-
-
-
- Gets the full virtual path to the directory item.
-
-
-
-
- Gets the virtual location of the directory item. When the item is not root, the value
- of this property should be string.Empty. The FileBrowser control recursively combines the names
- of all parent directory items in order to get the full virtual path of the item.
-
-
-
-
- Gets a DirectoryItem array containing all child directory items.
-
-
-
-
- Gets a FileItem array containing all child file items.
-
-
-
-
- Provides storage independent mechanism for uploading files and
- populating the content of the FileBrowser dialog controls.
-
-
-
-
- Creates a new instance of the class. Used internally by FileManager to create instances of the content provider.
-
- The current HttpContext.
- Search patterns for files. Allows wildcards.
- The paths which will be displayed in the FileManager. You can disregard
- this value if you have custom mechanism for determining the rights for directory / file displaying.
- The paths which will allow uploading in the FileManager. You can disregard this
- value if you have custom mechanism for determining the rights for uploading.
- The paths which will allow deleting in the dialog. You can disregard this
- value if you have custom mechanism for determining the rights for deleting.
- The selected url in the file browser. The file browser will navigate to the item
- which has this url.
- The selected tag in the file browser. The file browser will navigate to the
- item which has this tag.
-
-
-
- Resolves a root directory with the given path in list mode.
-
- The virtual path of the directory.
- A DirectoryItem array, containing the root directory and all child directories.
-
-
-
- Resolves a root directory with the given path in tree mode.
-
- The virtual path of the directory.
- A DirectoryItem, containing the root directory.
-
-
-
- Resolves a directory with the given path.
-
- The virtual path of the directory.
- A DirectoryItem, containing the directory.
-
- Used mainly in the Ajax calls.
-
-
-
-
- Get the name of the file with the given url.
-
- The url of the file.
- String containing the file name.
-
-
-
- Gets the virtual path of the item with the given url.
-
- The url of the item.
- String containing the path of the item.
-
-
-
- Gets a read only Stream for accessing the file item with the given url.
-
- The url of the file.
- Stream for accessing the contents of the file item with the given url.
-
-
-
- Stores an image with the given url and image format.
-
- The Bitmap object to be stored.
- The url of the bitmap.
- The image format of the bitmap.
- string.Empty when the operation was successful; otherwise an error message token.
-
- Used when creating thumbnails in the ImageManager dialog.
-
-
-
-
- Creates a file item from a HttpPostedFile to the given path with the given name.
-
- The uploaded HttpPostedFile to store.
- The virtual path where the file item should be created.
- The name of the file item.
- Additional values to be stored such as Description, DisplayName, etc.
- String containing the full virtual path (including the file name) of the file item.
-
- The default FileUploader control does not include the arguments parameter. If you need additional arguments
- you should create your own FileUploader control.
-
-
-
-
- Creates a file item from a Telerik.Web.UI.UploadedFile in the given path with the given name.
-
- The UploadedFile instance to store.
- The virtual path where the file item should be created.
- The name of the file item.
- Additional values to be stored such as Description, DisplayName, etc.
- String containing the full virtual path (including the file name) of the file item.
-
- The default FileUploader control does not include the arguments parameter. If you need additional arguments
- you should create your own FileUploader control.
-
-
-
-
- Deletes the file item with the given virtual path.
-
- The virtual path of the file item.
- string.Empty when the operation was successful; otherwise an error message token.
-
-
-
- Deletes the directory item with the given virtual path.
-
- The virtual path of the directory item.
- string.Empty when the operation was successful; otherwise an error message token.
-
-
-
- Creates a directory item in the given path with the given name.
-
- The path where the directory item should be created.
- The name of the new directory item.
- string.Empty when the operation was successful; otherwise an error message token.
-
-
-
- Moves a file from a one virtual path to a new one. This method can also be used for renaming items.
-
- old virtual location
- new virtual location
- string.Empty when the operation was successful; otherwise an error message token.
-
-
-
- Moves a directory from a one virtual path to a new one. This method can also be used for renaming items.
-
- old virtual location
- new virtual location
- string.Empty when the operation was successful; otherwise an error message token.
-
-
-
- Copies a file from a one virtual path to a new one.
-
- old virtual location
- new virtual location
- string.Empty when the operation was successful; otherwise an error message token.
-
-
-
- Copies a directory from a one virtual path to a new one
-
- old virtual location
- new virtual location
- string.Empty when the operation was successful; otherwise an error message token.
-
-
-
- Removes the protocol and the server names from the given url.
-
- Fully qualified url to a file or directory item.
- The root based absolute path.
-
-
-
-
-
-
- Checks if the current configuration allows writing (uploading) to the specified folder
-
- the virtual path that will be checked
- true if writing is allowed, otherwise false
-
-
-
- The current display mode of the content provider. Can be FileBrowserDisplayMode.Tree or FileBrowserDisplayMode.List.
- The value of this property is set by the FileBrowser control.
-
-
-
-
- Gets a value indicating whether the ContentProvider can create directory items or not. The visibility of the
- Create New Directory icon is controlled by the value of this property.
-
-
-
-
- The HttpContext object, set in the constructor of the class.
-
-
-
-
- Gets or sets the url of the selected item. The file browser will navigate to the item
- which has this url.
-
-
-
-
- Gets or sets the tag of the selected item. The file browser will navigate to the item
- which has this tag. Used mainly in Database content providers, where the file items have
- special url for accessing.
-
-
-
-
- Gets the search patterns for the file items to be displayed in the FileBrowser control. This property
- is set in the constructor of the class. Supports wildcards.
-
-
-
-
- Gets the paths which will be displayed in the dialog. This is passed by RadEditor and is
- one of the values of ImagesPaths, DocumentsPaths, MediaPaths, FlashPaths, TemplatesPaths properties.
- You can disregard this value if you have custom mechanism for determining the rights for
- directory / file displaying.
-
-
-
-
- Gets the paths which will allow uploading in the dialog. This is passed by RadEditor and is
- one of the values of UploadImagesPaths, UploadDocumentsPaths, UploadMediaPaths, UploadFlashPaths,
- UploadTemplatesPaths properties. You can disregard this value if you have custom mechanism for determining the rights
- for uploading.
-
-
-
-
- The paths which will allow deleting in the dialog. This is passed by RadEditor and is
- one of the values of DeleteImagesPaths, DeleteDocumentsPaths, DeleteMediaPaths, DeleteFlashPaths,
- DeleteTemplatesPaths properties. You can disregard this value if you have custom mechanism for determining the rights
- for deleting.
-
-
-
-
- The character, used to separate parts of the virtual path (e.g. '/' is the path separator in /path1/path2/file)
-
-
-
-
- Represents a file item in the FileBrowser control.
-
-
-
-
- Serializes the file item into a javascript array. This method should be overriden only when developing
- a custom FileBrowser control.
-
- a StringWriter used as a target for the serialization.
-
-
-
- Creates an instance of the FileItem class without setting any initial values.
-
-
-
-
- Creates an instance of the FileItem class.
-
- The name of the file item. The value of this property will be displayed in the FileBrowser control.
- The file extension of the file item.
- The size of the file item in bytes.
- The virtual path to the file item (needs to be unique). When the value is string.Empty, the location is the
- parent's full path + the name of the file.
- The url which will be inserted into the RadEditor content area.
- The tag of the file item. Used when the virtual path must be different than the url of the item.
- When the value of this property is set, the FileBrowser control uses it instead of the combined virtual path.
- The permissions on the file item.
-
-
-
- Gets the file extension of the file item.
-
-
-
-
- Gets the size of the file item in bytes.
-
-
-
-
- Gets the virtual path of the parent directory item. When the value is string.Empty, the location is got
- from the item's parent.
-
-
-
-
- Gets the virtual path of the parent directory item. When the value is string.Empty, the location is got
- from the item's parent.
-
-
-
-
- Gets the url which will be inserted into the RadEditor content area.
-
-
-
-
- Represents the actions which will be allowed on the FileBrowserItem.
-
-
-
- If you want to specify multiple permissions, use the following syntax:
-
-
- Dim permissions As PathPermissions = PathPermissions.Read Or PathPermissions.Upload Or PathPermissions.Delete
-
-
-
-
-
- The default permission. The FileBrowserItem can only be displayed.
-
-
-
-
- Used for DirectoryItems. If enabled, the Upload tab of the dialog will be enabled when
- the DirectoryItem is opened.
-
-
-
-
- If enabled, the DirectoryItem or the FileItem can be deleted.
-
-
-
-
- Container of misc. export settings of RadEditor control
-
-
-
-
- A string specifying the name (without the extension) of the file that will be
- created. The file extension is automatically added based on the method that is
- used.
-
-
-
- Opens the exported editor content in a new window instead of the same page.
-
-
-
- Contains export document which will be written to the response
-
-
-
-
- Provides enumerated values to be used to set edit mode in RadEditor
- This enumeration has a FlagsAttribute attribute that allows
- a bitwise combination of its member values.
-
-
-
-
- Design mode. The default edit mode in RadEditor, where you could edit HTML in WYSIWYG fashion.
-
-
-
-
- HTML mode. Advanced edit mode where you could directly modify the HTML.
-
-
-
-
- Preview mode. In this mode RadEditor will display its content the same way as it should be displayed when placed outside of the control.
-
-
-
-
- Provides enumerated values to be used to set format cleaning options on
- paste.
- This enumeration has a FlagsAttribute attribute that allows
- a bitwise combination of its member values.
-
-
-
- Doesn't strip anything on paste, asks a question when MS Word formatting detected.
-
-
- Doesn't strip anything on paste and does not ask a question.
-
-
- Strips only MSWord related attributes and tags on paste.
-
-
- Strips the MSWord related attributes and tags and font tags on paste.
-
-
- Strips MSWord related attributes and tags, font tags and font size attributes on paste.
-
-
- Removes style attributes on paste.
-
-
- Removes Font tags on paste.
-
-
- Clears Span tags on paste.
-
-
- Clears all tags except "br" and new lines (\n) on paste.
-
-
- Remove all HTML formatting on paste.
-
-
- Remove all HTML formatting on paste.
-
-
-
- Provides enumerated values to be used to set the active content filters
- This enumeration has a FlagsAttribute attribute that allows
- a bitwise combination of its member values.
-
-
-
-
- RadToolTip class
-
-
-
-
- RadToolTipBase class
-
-
-
-
- Causes a tooltip to open automatically when the page is loaded
-
-
-
-
- Gets or sets a value indicating whether the tooltip will open automatically when its parent [aspx] page is loaded on the client.
-
- The default value is false.
-
-
-
- Get/Set the animation effect of the tooltip
-
-
-
-
- Get/Set whether the tooltip will need to be closed manually by the user using the [x] button, or will close automatically
-
-
-
-
- Get/Set whether the tooltip will hide when the mouse moves away from the target element, or when the mouse [enters] and moves out of the tooltip itself.
-
-
-
-
- Get/Set the client event at which the tooltip will be hidden
-
-
-
-
- Get/Set the client event at which the tooltip will be made visible for a particular target control
-
-
-
-
- Get/Set the Width of the tooltip
-
-
-
-
- Get/Set the Height of the tooltip
-
-
-
-
- Get/Set the Text that will appear in the tooltip (if it should be other than the content of the 'title' attribute of the target element
-
-
-
-
- Get/Set a title for the tooltip
-
-
-
-
- Get/Set the the manual close button's tooltip text
-
-
-
-
- Get/Set the top/left position of the tooltip relative to the target element
-
-
-
-
- Get/Set overflow of the tooltip's content area
-
-
-
-
- Get/Set whether the tooltip should appear relative to the mouse or to the target element. Works in coopearation with the Position property.
-
-
-
-
- Get/Set the tooltip's horizontal offset from the target control. Works in coopearation with the Position property.
-
-
-
-
- Get/Set the tooltip's vertical offset from the target control. Works in coopearation with the Position property.
-
-
-
-
- Get/Set the delay after which the tooltip will hide if the mouse stands still over the target element.
-
-
-
-
- Get/Set delay in miliseconds for the tooltip to hide after the mouse leaves the target element.
-
-
-
-
- Get/Set the time for which the user should hold the mouse over a target element for the tooltip to appear
-
-
-
-
- Get/Set whether the tooltip will move to follow mouse movement or will stay fixed.
-
-
-
-
- Get/Set whether the tooltip will hide when the mouse moves away from the target element, or when the mouse [enters] and moves out of the tooltip itself.
-
-
-
-
- Get/Set whether the tooltip should be added as a child of the root element or as a child of its direct parent.
-
-
-
- Gets or sets a value indicating whether a tooltip is modal or not.
- The default value is false.
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadToolTip control is initialized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientBeforeShow
- client-side event handler is called before the RadToolTip
- is shown. Two parameters are passed to the handler:
-
- sender, the RadToolTip object.
- args.
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientBeforeShow property.
-
-
- <script type="text/javascript">
- function OnToolTipShowHandler(sender, args)
- {
- var tooltip = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the sliding is started.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientShow
- client-side event handler is called after the tooltip is shown
- Two parameters are passed to the handler:
-
- sender, the RadToolTip object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientShow property.
-
-
- <script type="text/javascript">
- function OnClientShowHandler(sender, args)
- {
- var tooltip = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- while the handle is being slided.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientBeforeHide
- client-side event handler that is called
- before the tooltip is hidden. Two parameters are passed to the handler:
-
- sender, the RadToolTip object.
- args.
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientBeforeHide property.
-
-
- <script type="text/javascript">
- function OnBeforeHideHandler(sender, args)
- {
- var tooltip = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when slide has ended.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientHide
- client-side event handler that is called
- after the tooltip is hidden. Two parameters are passed to the handler:
-
- sender, the RadToolTip object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientHide property.
-
-
- <script type="text/javascript">
- function OnHideHandler(sender, args)
- {
- var tooltip = sender;
- }
- </script>
-
-
-
-
-
-
- Get/Set the target control property of the tooltip
-
-
-
-
- Get/Set whether the TargetControlID is server or client ID
-
-
-
-
- RadTooltipManager class
-
-
-
-
- Allows for dynamic content to be set into the tooltip with an ajax request.
- The tooltip triggers the event when it is shown on the client.
-
-
- A string specifying the name of the server-side event handler that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnAjaxUpdate
- is triggered when the tooltip is shown on the client. Two parameters are passed to the handler:
-
- sender, the RadToolTip object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnAjaxUpdate property.
-
-
-
-
-
-
-
- Gets the settings for the web service used to populate items.
-
-
- An WebServiceSettings that represents the
- web service used for populating items.
-
-
-
- Use the WebServiceSettings property to configure the web
- service used to populate items on demand.
- You must specify both
- Path and
- Method
- to fully describe the service.
-
-
- In order to use the integrated support, the web service should have the following signature:
-
-
- [ScriptService]
- public class WebServiceName : WebService
- {
- [WebMethod]
- public string WebServiceMethodName(object context)
- {
- // We cannot use a dictionary as a parameter, because it is only supported by script services.
- // The context object should be cast to a dictionary at runtime.
- IDictionary<string, object> contextDictionary = (IDictionary<string, object>) context;
-
- //...
- }
- }
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadToolTipManager receives the server response from a WebService or AJAX request.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientResponseEnd
- client-side event handler is called before the RadToolTipManager
- displays the content returned from the server. Two parameters are passed to the handler:
-
- sender, the RadToolTipManager object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientResponseEnd property.
-
-
- <script type="text/javascript">
- function OnClientResponseEnd(sender, args)
- {
- var tooltipManager = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets the id (ClientID if a runat=server is used) of a html element whose children will be tooltipified
-
-
-
-
- Gets or sets a value whether the RadToolTipManager, when its TargetControls collection is empty will tooltipify automatically all elements on the page that have a 'title' attribute
-
-
-
-
- Gets a collection of TargetControl objects that allows for specifying the objects for which tooltips will be created on the client-side.
-
-
- Gets a collection of TargetControl objects that allows for specifying the objects for which tooltips will be created on the client-side.
-
-
- Use the TargetControls collection to programmatically control which objects should be tooltipified on the client-side.
-
-
-
-
- Gets a reference to the UpdatePanel property of RadToolTipManager. The UpdatePanel allows for sending AJAX content to the client-side during the OnAjaxUpdate event.
-
-
- Gets a reference to the UpdatePanel property of RadToolTipManager. The UpdatePanel allows for sending AJAX content to the client-side during the OnAjaxUpdate event.
-
-
-
-
- The ClientID of the target control for which the tooltip is currently being shown.
-
-
-
-
- An optional parameter allowing arbitrary information to be passed from the client to the server to help determine what information to load in the tooltip in the AJAX request
-
-
-
-
- Provides a reference to the UpdatePanel of RadToolTipManager. Allows content and controls to be set and displayed in the tooltip on the client
-
-
-
-
-
-
- The byte array, which is currently being used
- The index (distributed in the _bufferedBytes array and the chunk),
- at which the field starts
- The count of the field bytes to be added to the state store
- Indicates if this is the final part of data
- for the field (i.e. a boundary was found)
-
-
-
- Provides a way to access individual files that have been uploaded by a client
- via a RadUpload control.
-
-
- The UploadedFileCollection class provides access to all
- files uploaded from a client via single RadUpload instance as a file collection.
- UploadedFile provides properties and methods to get information on an
- individual file and to read and save the file. Files are uploaded in MIME
- multipart/form-data format and are NOT buffered in the server
- memory if the RadUploadModule is used.
- The RadUpload control must be used to select and upload
- files from a client.
- You can specify the maximum allowable upload file size in a machine.config or
- Web.config configuration file in the maxRequestLength attribute of the
- <httpRuntime> Element element.
-
-
- Set the maximum allowable upload file size to 1000kB
-
- <httpRuntime maxRequestLength="1000" />
-
-
- <httpRuntime maxRequestLength="1000" />
-
-
-
-
-
- Returns the name and extension of the file on the client's computer.
-
-
- A string consisting of the characters after the last directory character in file name on the client's computer.
-
-
- The separator characters used to determine the start of the
- file name are DirectorySeparatorChar and AltDirectorySeparatorChar.
-
-
-
-
- Returns the name of the file on the client's computer without the extension.
-
-
- A string containing the name of the file on the client's computer without the extension.
-
-
- A string containing the string returned by GetFileName, minus the last period (.) and all characters following it.
-
-
-
-
- Returns the extension of the file on the client's computer.
-
-
- A string containing the extension of the file including the ".". If the file name does not have
- extension information, GetExtension returns string.Empty.
-
-
- The extension of the file name is obtained by searching it for a period (.), starting with the last character
- and continuing toward the start. If a period is found before a DirectorySeparatorChar or AltDirectorySeparatorChar
- character, the returned string contains the period and the characters after it; otherwise, string.Empty is returned.
-
-
-
-
- Returns the value of a custom field.
-
-
- A string containing the value of the custom field with name fieldName
-
- The name of the field wich value will be retrieved
- Check the general help for more information and an example.
-
-
-
- Returns the checked state of a custom field.
-
-
- A string containing the checked state of the custom field with name fieldName
-
- The name of the field wich checked state will be retrieved
- Check the general help for more information and an example.
-
-
- Saves the contents of an uploaded file.
-
- The maximum allowed uploaded file size is 4MB by default. Maximum file size
- can be specified in the machine.config or Web.config configuration files in the
- maxRequestLength attribute of the <httpRuntime> element.
- The ASP.NET process must have proper rights for writing on the folder where
- the files are saved.
-
-
- The following example saves all the files uploaded by the client to a folder named
- "C:\TempFiles" on the Web server's local disk.
-
- Dim Loop1 As Integer
- Dim TempFileName As String
- Dim MyFileCollection As UploadedFileCollection = RadUpload1.UploadedFiles
-
- For Loop1 = 0 To MyFileCollection.Count - 1
- ' Create a new file name.
- TempFileName = "C:\TempFiles\File_" & CStr(Loop1)
- ' Save the file.
- MyFileCollection(Loop1).SaveAs(TempFileName)
- Next Loop1
-
-
- String TempFileName;
- UploadedFileCollection MyFileCollection = RadUpload1.UploadedFiles;
-
- for (int Loop1 = 0; Loop1 < MyFileCollection.Count; Loop1++)
- {
- // Create a new file name.
- TempFileName = "C:\\TempFiles\\File_" + Loop1.ToString();
- // Save the file.
- MyFileCollection[Loop1].SaveAs(TempFileName);
- }
-
-
-
-
- Saves the contents of an uploaded file.
-
- The maximum allowed uploaded file size is 4MB by default. Maximum file size
- can be specified in the machine.config or Web.config configuration files in the
- maxRequestLength attribute of the <httpRuntime> element.
- The ASP.NET process must have proper rights for writing on the folder where
- the files are saved.
-
-
- The following example saves all the files uploaded by the client to a folder named
- "C:\TempFiles" on the Web server's local disk. The existing files are overwritten.
-
- Dim Loop1 As Integer
- Dim TempFileName As String
- Dim ShouldOverwrite As Boolean = True
- Dim MyFileCollection As UploadedFileCollection = RadUpload1.UploadedFiles
-
- For Loop1 = 0 To MyFileCollection.Count - 1
- ' Create a new file name.
- TempFileName = "C:\TempFiles\File_" & CStr(Loop1)
- ' Save the file.
- MyFileCollection(Loop1).SaveAs(TempFileName, ShouldOverwrite)
- Next Loop1
-
-
- String TempFileName;
- bool ShouldOverwrite = true;
- UploadedFileCollection MyFileCollection = RadUpload1.UploadedFiles;
-
- for (int Loop1 = 0; Loop1 < MyFileCollection.Count; Loop1++)
- {
- // Create a new file name.
- TempFileName = "C:\\TempFiles\\File_" + Loop1.ToString();
- // Save the file.
- MyFileCollection[Loop1].SaveAs(TempFileName, ShouldOverwrite);
- }
-
-
- The name of the saved file.
-
- true to allow an existing file to be overwritten; otherwise, false.
-
-
-
-
- Creates a UploadedFile instance from HttpPostedFile instance.
-
- The value of the name attribute of the file input field
- (equals the UniqueID of the FileUpload control)
- The HttpPostedFile instance. Usually, you could get this from a
- ASP:FileUpload control's PostedFile property
-
-
-
-
- Creates a UploadedFile instance from HttpPostedFile instance.
-
- The HttpPostedFile instance. Usually, you could get this from a
- ASP:FileUpload control's PostedFile property
-
-
-
- Gets the size in bytes of an uploaded file.
- The length of the file.
-
- This example validates the file size of an uploaded file.
-
- bool isValid = true;
- if (file.ContentLength > MaxFileSize)
- {
- isValid = false;
- }
-
-
- Dim isValid As Boolean = True;
- If file.ContentLength > MaxFileSize Then
- isValid = False;
- End If
-
-
-
-
- Gets the MIME content type of a file sent by a client.
- The MIME content type of the uploaded file.
-
- The following example loops through all the files in the uploaded files collection
- and takes action when the MIME type of a file is US-ASCII .
-
- Dim Loop1 As Integer
- Dim MyFileCollection As UploadedFileCollection = RadUpload1.UploadedFiles
-
- For Loop1 = 0 To MyFileCollection.Count - 1
- If MyFileCollection(Loop1).ContentType = "video/mpeg" Then
- '...
- End If
- Next Loop1
-
-
- UploadedFileCollection MyFileCollection = RadUpload1.UploadedFiles;
-
- for (int Loop1 = 0; Loop1 < MyFileCollection.Count; Loop1++)
- {
- if (MyFileCollection[Loop1].ContentType == "video/mpeg")
- {
- //...
- }
- }
-
-
-
-
-
- Gets the fully-qualified name of the file on the client's computer (for example
- "C:\MyFiles\Test.txt").
-
- A string containing the fully-qualified name of the file on the client's computer.
-
- The following example assigns the name of an uploaded file (the first file in the
- file collection) to a string variable.
-
- UploadedFile MyUploadedFile = RadUpload1.UploadedFiles[0];
- string MyFileName = MyUploadedFile.FileName;
-
-
- Dim MyUploadedFile As UploadedFile = RadUpload1.UploadedFiles(0)
- Dim MyFileName As String = MyUploadedFile.FileName
-
-
-
-
-
- Gets a Stream object which points to the uploaded file to prepare for reading the contents of the file.
-
-
- A Stream pointing to the file.
-
-
-
-
- RadProgressManager Control
-
-
-
-
- Specifies the localization of the RadProgressArea (the language which will be used).
-
- The default value is en-US.
-
-
- <radU:RadUpload Language="es-Es" ... />
-
-
- <radU:RadUpload Language="es-Es" ... />
-
-
-
-
-
- Specifies the client-side function to be executed when the Progress Area status is about to be updated.
-
- The default value is string.Empty.
-
- This example demonstrates how to set a javascript function to execute when the
- client side progress area is about to be updated.
-
- <radU:RadProgressArea OnClientProgressUpdating="myOnClientProgressUpdating" ... />
- ...
- <script>
- function myOnClientProgressUpdating()
- {
- alert("The progress will be updated");
- }
- </script>
-
-
- <radU:RadProgressArea OnClientProgressUpdating="myOnClientProgressUpdating" ... />
- ...
- <script>
- function myOnClientProgressUpdating()
- {
- alert("The progress will be updated");
- }
- </script>
-
-
- Microsoft .NET Framework
-
-
-
- Specifies the client-side function to be executed when a progress bar is about to be updated.
-
- The default value is string.Empty.
- Microsoft .NET Framework
-
-
-
- Provides access to the localization strings of the control.
-
-
- This example demonstrates how to change the localization strings of RadProgressArea
- object with code.
-
- RadProgressArea1.Localization["CancelButton"] = "Cancel";
- RadProgressArea1.Localization["ElapsedTime"] = "Elapsed time: ";
- RadProgressArea1.Localization["EstimatedTime"] = "Estimated time: ";
- RadProgressArea1.Localization["TransferSpeed"] = "Speed: ";
- RadProgressArea1.Localization["CurrentFileName"] = "Uploading file: ";
- RadProgressArea1.Localization["Uploaded"] = "Uploaded ";
- RadProgressArea1.Localization["UploadedFiles"] = "Uploaded files: ";
- RadProgressArea1.Localization["Total"] = "Total ";
- RadProgressArea1.Localization["TotalFiles"] = "Total files: ";
-
-
- RadProgressArea1.Localization("CancelButton") = "Cancel"
- RadProgressArea1.Localization("ElapsedTime") = "Elapsed time: "
- RadProgressArea1.Localization("EstimatedTime") = "Estimated time: "
- RadProgressArea1.Localization("TransferSpeed") = "Speed: "
- RadProgressArea1.Localization("CurrentFileName") = "Uploading file: "
- RadProgressArea1.Localization("Uploaded") = "Uploaded "
- RadProgressArea1.Localization("UploadedFiles") = "Uploaded files: "
- RadProgressArea1.Localization("Total") = "Total "
- RadProgressArea1.Localization("TotalFiles") = "Total files: "
-
-
-
- Localization name/value collection.
-
-
- This property is intended to be used when there is a need to access the localization
- strings of the control from the code behind.
-
-
-
-
-
-
-
-
- RadProgressManager control
-
-
-
-
-
-
-
-
- Adds RadUrid=[GUID] parameter to the supplied URL.
-
-
- Use this method to generate proper URL for cross page postbacks
- which will enable RadMemoryOptimization and RadProgressArea.
-
-
- This example demonstrates how to set the PostBackUrl property of a button
- in order to enable RadMemoryOptimization and RadProgressArea. This example
- will postback to the current page, but you could use URL of your choice.
-
- Button1.PostBackUrl = RadProgressManager1.ApplyUniquePageIdentifier(Request.Url.PathAndQuery)
-
-
- Button1.PostBackUrl = RadProgressManager1.ApplyUniquePageIdentifier(Request.Url.PathAndQuery);
-
-
-
-
-
- Deprecated. Memory optimization is implemented as part of the .NET Framework and is no longer a feature of RadUpload.
-
-
-
-
- Gets or sets a value indicating wether an error message will be displayed when the RadUploadHttpModule is not registered.
-
-
-
-
- Gets or sets the period (in milliseconds) of the progress data refresh.
-
-
- The period of the progress data refresh in milliseconds. The default value is
- 500.
-
-
- The refresh period might not be exactly the same as the value specified if
- the AJAX request has not been completed before the upload. The minimum value is 50
- ms.
- Note: If the value is very low (50ms) both the client CPU
- and server CPU load would increase because of the increased number of AJAX requests
- performed.
-
-
-
-
-
-
-
-
- RadProgressManager's FormId property is not used anymore. Please, remove any assignments.
-
-
-
- Specifies which control objects will be visible on a RadUpload control.
-
-
- Only the file inputs will be visible.
-
-
- Display checkboxes for selecting a file input.
-
-
- Display buttons for removing a file input.
-
-
- Display buttons for clearing a file input.
-
-
- Display button for adding a file input.
-
-
- Display button for removing the file inputs with checked checkboxes.
-
-
- CheckBoxes | RemoveButtons | AddButton | DeleteSelectedButton
-
-
-
- CheckBoxes | RemoveButtons | ClearButtons | AddButton |
- DeleteSelectedButton
-
-
-
-
- Telerik RadUpload
-
-
-
-
- Fires the ValidatingFile event.
-
-
-
-
- Fires the FileExists event.
-
-
-
-
- Occurs before the internal validation of every file in the UploadedFiles collection.
-
-
- To skip the internal validation of the file, set e.SkipInternalValidation = true.
-
-
- This example demostrates how to implement custom validation for specific file type.
-
-
- Private Sub RadUpload1_ValidatingFile(ByVal sender As Object, ByVal e As WebControls.ValidateFileEventArgs) Handles RadUpload1.ValidatingFile
- If e.UploadedFile.GetExtension.ToLower = ".zip" Then
- Dim maxZipFileSize As Integer = 10000000 '~10MB
- If e.UploadedFile.ContentLength > maxZipFileSize Then
- e.IsValid = False
- End If
- 'The zip files are not validated for file size, extension and mime type
- e.SkipInternalValidation = True
- End If
- End Sub
-
-
- private void RadUpload1_ValidatingFile(object sender, ValidateFileEventArgs e)
- {
- if (e.UploadedFile.GetExtension().ToLower() == ".zip")
- {
- int maxZipFileSize = 10000000; //~10MB
- if (e.UploadedFile.ContentLength > maxZipFileSize)
- {
- e.IsValid = false;
- }
- //The zip files are not validated for file size, extension and content type
- e.SkipInternalValidation = true;
- }
- }
-
-
- MaxFileSize Property
- AllowedMimeTypes Property
- AllowedFileExtensions Property
-
-
-
- Occurs after an unsuccessful attempt for automatic saving of a file in the
- UploadedFiles collection.
-
-
-
- This event should be consumed only when the automatic file saving is enabled by
- setting the TargetFolder property. In this mode
- the files are saved in the selected folder with the same name as on the client
- computer. If a file with such name already exists in the
- TargetFolder it is either overwritten or skipped
- depending the value of the
- OverwriteExistingFiles property. This
- event is fired if
- OverwriteExistingFiles is set to
- false and a file with the same name already exists in the
- TargetFolder.
-
-
-
- This example demostrates how to create custom logic for renaming and saving the
- existing uploaded files.
-
- Private Sub RadUpload1_FileExists(ByVal sender As Object, ByVal e As WebControls.UploadedFileEventArgs) Handles RadUpload1.FileExists
- Dim TheFile As Telerik.WebControls.UploadedFile = e.UploadedFile
-
- TheFile.SaveAs(Path.Combine(RadUpload1.TargetFolder, TheFile.GetNameWithoutExtension() + "1" + TheFile.GetExtension()), true)
- End Sub
-
-
- private void RadUpload1_FileExists(object sender, Telerik.WebControls.UploadedFileEventArgs e)
- {
- Telerik.WebControls.UploadedFile TheFile = e.UploadedFile;
-
- TheFile.SaveAs(Path.Combine(RadUpload1.TargetFolder, TheFile.GetNameWithoutExtension() + "1" + TheFile.GetExtension()), true);
- }
-
-
- OverwriteExistingFiles Property
- TargetFolder Property
- TargetPhysicalFolder Property
-
-
-
- Gets or sets the size of the file input field
-
- The default value is 23.
-
-
-
- Gets or sets the allowed file extensions for uploading.
-
-
- Set this property to empty array of strings in order to prevent the file
- extension checking.
- Note that the file extensions must include the dot before the actual
- extension. See the example below.
-
-
- The default value is empty string array. In order to check for multiple file
- extensions you should set an array of strings containing the allowed file extensions
- for uploading.
-
-
- This example demonstrates how to set multiple allowed file extensions in a
- RadUpload control.
-
- Dim allowedFileExtensions As String() = New String(2) {".zip", ".doc", ".config"}
- RadUpload1.AllowedFileExtensions = allowedFileExtensions
-
-
- string[] allowedFileExtensions = new string[3] {".zip", ".doc", ".config"};
- RadUpload1.AllowedFileExtensions = allowedFileExtensions;
-
-
- MaxFileSize Property
- AllowedMimeTypes Property
- ValidatingFile Event
-
-
-
- Gets or sets the allowed MIME types for uploading.
-
-
- Set this property to string.Empty in order to prevent the
- mime type checking.
-
-
- The default value is empty string array. In order to check for multiple mime
- types you should set an array of strings containing the allowed MIME types
- for uploading.
-
-
- This example demostrates how to set multiple allowed MIME types to a RadUpload
- control.
-
- ' For example you can Get these from your web.config file
- Dim commaSeparatedMimeTypes As String = "application/octet-stream,application/msword,video/mpeg"
-
- Dim allowedMimeTypes As String() = commaSeparatedMimeTypes.Split(",")
- RadUpload1.AllowedMimeTypes = allowedMimeTypes
-
-
- // For example you can get these from your web.config file
- string commaSeparatedMimeTypes = "application/octet-stream,application/msword,video/mpeg";
-
- string[] allowedMimeTypes = commaSeparatedMimeTypes.Split(',');
- RadUpload1.AllowedMimeTypes = allowedMimeTypes;
-
-
- MaxFileSize Property
- AllowedFileExtensions Property
- ValidatingFile Event
-
-
-
- Gets or sets the value indicating which control objects will be displayed.
-
-
- The default value is ControlObjectsVisibility.Default. You can
- set any combination of the enum values.
-
-
- ControlObjectVisibility enum members
-
-
- Member
- Description
-
-
- None
- Only the file inputs will be visible.
-
-
- CheckBoxes
- Display checkboxes for selecting a file input.
-
-
- RemoveButtons
- Display buttons for removing a file input.
-
-
- ClearButtons
- Display buttons for clearing a file input.
-
-
- AddButton
- Display button for adding a file input.
-
-
- DeleteSelectedButton
- Display button for removing the file inputs with checked
- checkboxes.
-
-
- Default
- CheckBoxes | RemoveButtons | AddButton |
- DeleteSelectedButton
-
-
- All
- CheckBoxes | RemoveButtons | ClearButtons | AddButton |
- DeleteSelectedButton
-
-
-
-
- This example demostrates how to display only the Add and Remove buttons on a
- RadUpload control.
-
- RadUpload1.ControlObjectsVisibility = Telerik.WebControls.ControlObjectsVisibility.AddButton Or _
- Telerik.WebControls.ControlObjectsVisibility.RemoveButtons
-
-
- RadUpload1.ControlObjectsVisibility = Telerik.WebControls.ControlObjectsVisibility.AddButton |
- Telerik.WebControls.ControlObjectsVisibility.RemoveButtons;
-
-
- MaxFileInputsCount Property
- InitialFileInputsCount Property
- ControlObjectsVisibility Enumeration
-
-
-
- Gets or sets the value indicating whether the file input fields skinning will be enabled.
-
-
- true when the file input skinning is enabled; otherwise false.
-
-
- The <input type=file> DHTML elements are not skinnable by default. If the
- EnableFileInputSkinning is true some browsers can have strange behaviour.
-
-
-
-
- Gets or sets the initial count of file input fields, which will appear in RadUpload.
-
-
- The file inputs count which will be available at startup. The default value is
- 1.
-
- MaxFileInputsCount Property
- ControlObjectsVisibility Property
-
-
-
- Provides access to the invalid files uploaded by the RadUpload
- instance. This is populated only if a validation was set.
-
-
- If the internal validation is enabled this collection contains the invalid
- uploaded files for the particular instance of RadUpload
- control.
-
-
-
-
- Gets or sets the localization language of the RadUpload user interface.
-
-
- A string containing the localization language of the RadUpload user inteface. The
- default value is en-US.
-
-
-
-
- Gets or sets the maximum file input fields that can be added to the control.
-
- The default value is 0 (unlimited).
-
- Using this property you can limit the maximum number of file inputs which can be
- added to a RadUpload instance.
-
- InitialFileInputsCount Property
- ControlObjectsVisibility Property
-
-
- Gets or sets the maximum file size allowed for uploading in bytes.
- The default value is 0 (unlimited).
- Set this property to 0 in order to prevent the file size checking.
- AllowedMimeTypes Property
- AllowedFileExtensions Property
- ValidatingFile Event
-
-
-
- Gets or sets the name of the client-side function which will be executed before
- a new fileinput is added to a RadUpload instance.
-
- The default value is string.Empty.
-
- This example demonstrates how to create a javascript function which is called every
- time when the used adds a new file input to the RadUpload instance.
-
- <radU:RadUpload OnClientAdding="myOnClientAdding" ... />
- ...
- <script>
- function myOnClientAdding()
- {
- alert("You just added a new file input.");
- }
- </script>
-
-
- <radU:RadUpload OnClientAdding="myOnClientAdding" ... />
- ...
- <script>
- function myOnClientAdding()
- {
- alert("You just added a new file input.");
- }
- </script>
-
-
-
-
-
- Gets or sets the name of the client-side function which will be executed after
- a new fileinput is added to a RadUpload instance.
-
- The default value is string.Empty.
-
- This example demonstrates how to create a javascript function which is called every
- time when the used adds a new file input to the RadUpload instance.
-
- <radU:RadUpload OnClientAdded="myOnClientAdded" ... />
- ...
- <script>
- function myOnClientAdded()
- {
- alert("You just added a new file input.");
- }
- </script>
-
-
- <radU:RadUpload OnClientAdded="myOnClientAdded" ... />
- ...
- <script>
- function myOnClientAdded()
- {
- alert("You just added a new file input.");
- }
- </script>
-
-
-
-
-
- Gets or sets the name of the client-side function which will be executed before a file input is deleted
- from a RadUpload instance.
-
- The default value is string.Empty.
-
- This example demonstrates how to implement a confirmation dialog when removing a
- file input item.
-
- <radU:RadUpload OnClientDeleting="myOnClientDeleting" ... />
- <script language="javascript">
- function myOnClientDeleting()
- {
- return prompt("Are you sure?");
- }
- </script>
-
-
- <radU:RadUpload OnClientDeleting="myOnClientDeleting" ... />
- <script language="javascript">
- function myOnClientDeleting()
- {
- Return prompt("Are you sure?");
- }
- </script>
-
-
-
- If you want to cancel the deleting of the file input return
- false in the javascript handler.
-
-
-
-
- Gets or sets the name of the client-side function which will be executed before a fileinput field is
- cleared in a RadUpload instance using the Clear button.
-
- The default value is string.Empty.
-
- This example demonstrates how to create a client side confirmation dialog when
- clearing a file input item of a RadUpload instance.
-
- <radU:RadUpload OnClientClearing="myOnClientClearing" ... />
- ...
- <script>
- function myOnClientClearing()
- {
- return confirm("Are you sure you want to clear this input?");
- }
- </script>
-
-
- <radU:RadUpload OnClientClearing="myOnClientClearing" ... />
- ...
- <script>
- function myOnClientClearing()
- {
- Return confirm("Are you sure you want to clear this input?");
- }
- </script>
-
-
-
-
-
- Gets or sets the name of the client-side function which will be executed when a file input value changed.
-
- The default value is string.Empty.
-
-
-
- Gets or sets the name of the client-side function which will be executed before the selected file inputs are removed.
-
- The default value is string.Empty.
-
- This example demonstrates how to create a client side confirmation dialog when
- removing the selected file input items from a RadUpload control.
-
- <radU:RadUpload OnClientDeletingSelected="myOnClientDeletingSelected" ... />
-
- <script>
- function myOnClientDeletingSelected()
- {
- var mustCancel = confirm("Are you sure?");
- return mustCancel;
- }
- </script>
-
-
- <radU:RadUpload OnClientDeletingSelected="myOnClientDeletingSelected" ... />
-
- <script>
- function myOnClientDeletingSelected()
- {
- var mustCancel = confirm("Are you sure?");
- return mustCancel;
- }
- </script>
-
-
-
- You can cancel the removing of the file input items by returning
- false in the javascript function.
-
-
-
-
- Gets or sets the value indicating whether RadUpload should overwrite existing files having same name in the TargetFolder.
-
-
- true when the existing files should be overwritten; otherwise
- false. The default value is false.
-
-
- When set to true, the existing files are overwritten, else no
- action is taken.
-
- FileExists Event
- TargetFolder Property
- TargetPhysicalFolder Property
-
-
-
- Gets or sets a value indicating if the file input fields should be read-only
- (e.g. no typing allowed).
-
-
- true when the file input fields should be read-only; otherwise
- false.
-
-
- When users type into the box and the filename is not valid, the form submission
- in Internet Explorer could not proceed or even display a javascript error. This
- behavior can be avoided by setting the ReadOnlyFileInputs property to true.
-
-
-
-
- Gets or sets the virtual path of the folder, where RadUpload will automatically save the valid files after the upload completes.
-
-
- A string containing the virtual path of the folder where RadUpload will automatically save the valid files
- after the upload completes. The default value is string.Empty.
-
-
- When set to string.Empty, the files must be saved manually to the desired location.
- If both TargetPhysicalFolder property and this property are set, the
- TargetPhysicalFolder will override the virtual path provided by TargetFolder.
-
- OverwriteExistingFiles Property
- FileExists Event
- TargetPhysicalFolder Property
-
-
-
- Gets or sets the physical path of the folder, where RadUpload will automatically save the valid files after the upload completes.
-
-
- A string containing the physical path of the folder where RadUpload will automatically save the valid files
- after the upload completes. The default value is string.Empty.
-
-
- When set to string.Empty, the files must be saved manually to the desired location.
- If both TargetFolder property and this property are set, the
- TargetPhysicalFolder will override the virtual path provided by TargetFolder.
-
- TargetFolder Property
- OverwriteExistingFiles Property
- FileExists Event
-
-
-
- Provides access to the valid files uploaded by the RadUpload
- instance.
-
-
- UploadedFileCollection containing all valid files uploaded using
- a RadUpload control.
-
-
- The collection contains only the files uploaded with the particular instance of
- the RadUpload control. If the RadUploadHttpModule is used, the
- uploaded files are removed from the Request.Files collection in order
- to conserve the server's memory. Else the Request.Files contains all uploaded files as
- a HttpPostedFile collection and each RadUpload instance has its own
- uploaded files as UploadedFileCollection.
-
-
- This example demonstrates how to save the valid uploaded files with a
- RadUpload control.
-
- For Each file As Telerik.WebControls.UploadedFile In RadUpload1.UploadedFiles
- file.SaveAs(Path.Combine("c:\my files\", file.GetName()), True)
- Next
-
-
- foreach (Telerik.WebControls.UploadedFile file in RadUpload1.UploadedFiles)
- {
- file.SaveAs(Path.Combine(@"c:\my files\", file.GetName()), true);
- }
-
-
-
-
- Gets or sets the value indicating whether the first file input field of RadUpload should get
- the focus on itself on load.
-
- true when the first file input field of RadUpload should get
- the focus; otherwise false. The default value is false.
-
-
-
-
- Gets a value indicating whether the RadUpload HttpModule is registered in the current web.application
-
-
-
- Provides access to and organizes files uploaded by a client.
-
- Clients encode files and transmit them in the content body using multipart MIME
- format with an HTTP Content-Type header of multipart/form-data. RadUpload
- extracts the encoded file(s) from the content body into individual members of an
- UploadedFileCollection. Methods and properties of the
- UploadedFile class provide access to the contents and properties of
- each file.
-
-
-
-
- Gets an individual UploadedFile object from the file
- collection.
- In C#, this property is the indexer for the
- UploadedFileCollection class.
-
- The UploadedFile specified by index.
-
- The following example retrieves the first file object (index = 0) from the
- collection sent by the client and retrieves the name of the actual file represented
- by the object.
-
- Dim MyUploadedFile As UploadedFile = RadUpload1.UploadedFiles(0)
- Dim MyFileName As String = UploadedFile.FileName
-
-
- HttpPostedFile MyUploadedFile = RadUpload1.UploadedFiles[0];
- String MyFileName = MyUploadedFile.FileName;
-
-
- UploadedFile Class
- The index of the item to get from the file collection.
-
-
-
- This class loads the dialog resources - localization, skins, base scripts, etc.
-
-
-
-
- Gets or sets a string containing the localization language for the RadEditor UI
-
-
-
-
- Telerik RadWindow
-
-
-
-
- Gets or sets the client callback function that will be called when a window
- dialog is being closed.
- This property is obsolete. Please use OnclientClose instead. For more information
- visit http://www.telerik.com/help/aspnet-ajax/window_programmingusingradwindowasadialog.html
-
-
-
-
- Gets or sets the id (ClientID if a runat=server is used) of a html element, whose
- left and top position will be used as 0,0 of the RadWindow object when it is first
- shown.
-
-
-
-
- Gets or sets the id (ClientID if a runat=server is used) of a html element where
- the windows will be "docked" when minimized.
-
-
-
-
- Gets or sets the url of the icon in the upper left corner of the
- RadWindow titlebar.
-
-
-
-
- Gets or sets the url of the minimized icon of the
- RadWindow.
-
-
-
-
- Gets or sets a value indicating the behavior of this object - if can be resized, has expand/collapse commands, closed command, etc.
-
-
-
-
- Gets or sets a value indicating the initial behavior of this object - most useful to specify an initially minimized, maximized or pinned window.
-
-
-
-
- Get/Set the animation effect of the window
-
-
-
-
- Get/Set the Width of the window
-
-
-
-
- Get/Set the Height of the window
-
-
-
-
- Get/Set a title for the window
-
-
-
-
- Gets or sets the horizontal distance from the browser origin, or from the top left corner of the OffsetElement
-
-
-
-
- Gets or sets the vertical distance from the browser origin, or from the top left corner of the OffsetElement
-
-
-
-
- Gets or sets the id (ClientID if a runat=server is used) of a html element in which
- the windows will be able to move.
-
-
-
-
- Gets or sets a value indicating whether the window will be disposed and made inaccessible once it is closed.
- If property is set to true, the next time a window with this ID is requested, a new window with default settings is created and returned.
-
- The default value is false.
-
-
-
- Gets or sets a value indicating whether the page that is loaded in the window should be loaded everytime from the server or
- will leave the browser default behaviour.
-
- The default value is false.
-
-
-
- Gets or sets a value indicating whether the page that is loaded
- in the window should be shown during the loading process, or when it has finished loading.
-
- The default value is true.
-
-
-
- Gets or sets a value indicating whether the window will open automatically when its parent [aspx] page is loaded on the client.
-
- The default value is false.
-
-
- Gets or sets a value indicating whether the window has a titlebar visible.
- The default value is true.
-
-
-
- Gets or sets a value indicating whether the window has a visible status bar or
- not.
-
- The default value is true.
-
-
- Gets or sets a value indicating whether a dialog is modal or not.
- The default value is false.
-
-
- Gets or sets a value indicating whether the window will create an overlay element.
- The default value is false.
-
-
- Gets or sets a value indicating what should be the opacity of the RadWindow. The value must be between 0 (transparent) and 100 (opaque).
- The default value is 100.
-
-
- Gets or sets a value indicating whether the window will stay in the visible viewport of the browser window.
- The default value is false.
-
-
- Gets or sets a value indicating whether the window will automatically resize itself acciording to its content page or not.
- The default value is false.
-
-
-
- Gets or sets the client-side script that executes when a RadWindow command (Restore, Minimize, Maximize, Pin On, Pin Off, Reload is raised
-
-
-
-
- Gets or sets the client-side script that executes when a RadWindow Resize event is raised
-
-
-
-
- Gets or sets the client-side script that executes when a RadWindow DragStart event is raised
-
-
-
-
- Gets or sets the client-side script that executes when a RadWindow DragEnd event is raised
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadWindow control becomes the active visible window.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientActivate
- client-side event handler is called when the RadWindow
- control becomes the active visible window Two parameters are passed to the handler:
-
- sender, the RadWindow object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientActivate property.
-
-
- <script type="text/javascript">
- function OnWindowActivateHandler(sender, args)
- {
- var window = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called before
- the sliding is started.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientShow
- client-side event handler is called after the window is shown
- Two parameters are passed to the handler:
-
- sender, the RadWindow object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientShow property.
-
-
- <script type="text/javascript">
- function OnClientShowHandler(sender, args)
- {
- var window = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when the page inside the RadWindow object completes loading.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientPageLoad
- client-side event handler that is called
- when the page inside the RadWindow object completes loading. Two parameters are passed to the handler:
-
- sender, the RadWindow object.
- args.
-
-
-
- The following example demonstrates how to use the
- OnClientPageLoad property.
-
-
- <script type="text/javascript">
- function OnPageLoadHandler(sender, args)
- {
- var window = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when slide has ended.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientClose
- client-side event handler that is called
- after the window is hidden. Two parameters are passed to the handler:
-
- sender, the RadWindow object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientClose property.
-
-
- <script type="text/javascript">
- function OnCloseHandler(sender, args)
- {
- var window = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when the RadWindow is closing.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientClosing
- client-side event handler that is called
- just before the window is hidden. Two parameters are passed to the handler:
-
- sender, the RadWindow object.
- args.
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientClosing property.
-
-
- <script type="text/javascript">
- function OnClosingHandler(sender, args)
- {
- var window = sender;
- }
- </script>
-
-
-
-
-
-
- Get/Set the target control property of the tooltip
-
-
-
-
- Specifies the URL that will originally be loaded in the
- RadWindow (can be changed on the client).
-
- The default is an empty string - "".
-
-
-
- Gets a collection of RadWindow objects
-
-
- Gets a collection of RadWindow objects
-
-
-
-
- Gets or sets a value indicating whether window objects' state (size, location, behavior) will be
- persisted in a client cookie to restore state over page postbacks.
-
-
-
-
- This property allows to specify the HTML for the alert popup, which will override
- the alerttemplate defined in the
- Skins/CURRENT_SKIN/Window/CoreTemplates.xml file.
-
-
-
-
- This property allows to specify the HTML for the confirm popup, which will
- override the alerttemplate defined in the
- Skins/CURRENT_SKIN/Window/CoreTemplates.xml file.
-
-
-
-
- This property allows to specify the HTML for the prompt popup, which will
- override the alerttemplate defined in the
- Skins/CURRENT_SKIN/Window/CoreTemplates.xml file.
-
-
-
-
- Specifies the behaviors of the radWindow object
-
-
-
-
- No behavior is specified.
-
- 0
-
-
-
- The object can be resized.
-
- 1
-
-
-
- The object can be minimized.
-
- 2
-
-
-
- The object can be closed.
-
- 4
-
-
-
- The objct can be pinned.
-
- 8
-
-
-
- The object can be maximized.
-
- 16
-
-
-
- The object can be moved.
-
- 32
-
-
-
- The object will have a reload button.
-
- 64
-
-
-
- Default object behavior: all together.
-
- (Minimize | Maximize | Close | Pin | Resize | Move | Reload)
-
-
-
- ApocDriver provides the client with a single interface to invoking Apoc XSL-FO.
-
-
- The examples belows demonstrate several ways of invoking Apoc XSL-FO. The
- methodology is the same regardless of how Apoc is embedded in your
- system (ASP.NET, WinForm, Web Service, etc).
-
-
-
- // This example demonstrates rendering an XSL-FO file to a PDF file.
- ApocDriver driver = ApocDriver.Make();
- driver.Render(
- new FileStream("readme.fo", FileMode.Open),
- new FileStream("readme.pdf", FileMode.Create));
-
-
- // This example demonstrates rendering an XSL-FO file to a PDF file.
- Dim driver As ApocDriver = ApocDriver.Make
- driver.Render( _
- New FileStream("readme.fo", FileMode.Open), _
- New FileStream("readme.pdf", FileMode.Create))
-
-
- // This example demonstrates rendering the result of an XSLT transformation
- // into a PDF file.
- ApocDriver driver = ApocDriver.Make();
- driver.Render(
- XslTransformer.Transform("readme.xml", "readme.xsl"),
- new FileStream("readme.pdf", FileMode.Create));
-
-
- // This example demonstrates rendering the result of an XSLT transformation
- // into a PDF file.
- Dim driver As ApocDriver = ApocDriver.Make
- driver.Render( _
- XslTransformer.Transform("readme.xml", "readme.xsl"), _
- New FileStream("readme.pdf", FileMode.Create))
-
-
- // This example demonstrates using an XmlDocument as the source of the
- // XSL-FO tree. The XmlDocument could easily be dynamically generated.
- XmlDocument doc = new XmlDocument()
- doc.Load("reader.fo");
-
- ApocDriver driver = ApocDriver.Make();
- driver.Render(doc, new FileStream("readme.pdf", FileMode.Create));
-
-
- // This example demonstrates using an XmlDocument as the source of the
- // XSL-FO tree. The XmlDocument could easily be dynamically generated.
- Dim doc As XmlDocument = New XmlDocument()
- doc.Load("reader.fo")
-
- Dim driver As ApocDriver = ApocDriver.Make
- driver.Render(doc, New FileStream("readme.pdf", FileMode.Create))
-
-
-
-
-
- This interface is implemented by the ApocDriver class to permit usage
- from COM applications. This is the recommended method of supporting
- invocation from COM application as it permits interface versioning.
-
-
-
-
- Controls the output format of the renderer.
-
-
- Defaults to PDF.
-
-
-
-
- Determines if the output stream passed to
- should be closed upon completion or if a fatal exception occurs.
-
-
-
-
- Options to supply to the renderer.
-
-
-
-
- Maps a set of credentials to an internet resource
-
-
-
-
- The ResourceManager embedded in the core dll.
-
-
-
-
- The active driver.
-
-
-
-
- Permits the product key to be specified using code, rather than
- the flakey licenses.licx method.
-
-
-
-
- Constructs a new ApocDriver and registers the newly created
- driver as the active driver.
-
- An instance of ApocDriver
-
-
-
- Sets the the 'baseDir' property in the Configuration class using
- the value returned by Directory.GetCurrentDirectory().
-
-
-
-
- An optional image handler that can be registered to load image
- data for external graphic formatting objects.
-
-
-
-
- Executes the conversion reading the source tree from the supplied
- XmlDocument, converting it to a format dictated by the renderer
- and writing it to the supplied output stream.
-
-
- An in-memory representation of an XML document (DOM).
-
-
- Any subclass of the Stream class.
-
-
- Any exceptions that occur during the render process are arranged
- into three categories: information, warning and error. You may
- intercept any or all of theses exceptional states by registering
- an event listener. See for an
- example of registering an event listener. If there are no
- registered listeners, the exceptions are dumped to standard out -
- except for the error event which is wrapped in a
- .
-
-
-
-
- Executes the conversion reading the source tree from the input
- reader, converting it to a format dictated by the renderer and
- writing it to the supplied output stream.
-
- A character orientated stream
- Any subclass of the Stream class
-
-
-
- Executes the conversion reading the source tree from the file
- inputFile, converting it to a format dictated by the
- renderer and writing it to the file identified by outputFile.
-
-
- If the file outputFile does not exist, it will created
- otherwise it will be overwritten. Creating a file may
- generate a variety of exceptions. See
- for a complete list.
-
- Path to an XSL-FO file
- Path to a file
-
-
-
- Executes the conversion reading the source tree from the file
- inputFile, converting it to a format dictated by the
- renderer and writing it to the supplied output stream.
-
- Path to an XSL-FO file
-
- Any subclass of the Stream class, e.g. FileStream
-
-
-
-
- Executes the conversion reading the source tree from the input
- stream, converting it to a format dictated by the render and
- writing it to the supplied output stream.
-
- Any subclass of the Stream class, e.g. FileStream
- Any subclass of the Stream class, e.g. FileStream
-
-
-
- Executes the conversion reading the source tree from the input
- reader, converting it to a format dictated by the render and
- writing it to the supplied output stream.
-
-
- The evaluation copy of this class will output an evaluation
- banner to standard out
-
-
- Reader that provides fast, non-cached, forward-only access
- to XML data
-
-
- Any subclass of the Stream class, e.g. FileStream
-
-
-
-
- Retrieves the string resource with the specific key using the
- default culture
-
- A resource key
-
- The resource string identified by key from the
- current culture's setting
-
-
- The key parameter is a null reference
-
- The value of the specified resource is not a string
-
- No usable set of resources has been found, and there are no
- neutral culture resources
-
-
-
-
- Sends an 'error' event to all registered listeners.
-
-
- If there are no listeners, a is
- thrown immediately halting execution
-
- Any error message, which may be null
-
- If no listener is registered for this event, a SystemException
- will be thrown
-
-
-
-
- Sends a 'warning' event to all registered listeners
-
-
- If there are no listeners, message is written out
- to the console instead
-
- Any warning message, which may be null
-
-
-
- Sends an 'info' event to all registered lisetners
-
-
- If there are no listeners, message is written out
- to the console instead
-
- An info message, which may be null
-
-
-
- Utility method that creates an
- for the supplied file
-
-
- The returned interprets all whitespace
-
-
-
-
- Utility method that creates an
- for the supplied file
-
-
- The returned interprets all whitespace
-
-
-
-
- Utility method that creates an
- for the supplied file
-
-
- The returned interprets all whitespace
-
-
-
-
- A multicast delegate. The error event Apoc publishes.
-
-
- The method signature for this event handler should match
- the following:
-
- The first parameter driver will be a reference to the
- active ApocDriver instance.
-
-
-
-
- A multicast delegate. The info event Apoc publishes.
-
-
- The method signature for this event handler should match
- the following:
-
- The first parameter driver will be a reference to the
- active ApocDriver instance.
-
-
-
-
- Determines if the output stream should be automatically closed
- upon completion of the render process.
-
-
-
-
- Gets or sets the active .
-
-
- An instance of created via the factory method
- .
-
-
-
-
- Determines which rendering engine to use.
-
-
- A value from the enumeration.
-
-
- The default value is
- .
-
-
-
-
- Gets or sets the base directory used to locate external
- resourcs such as images.
-
-
- Defaults to the current working directory.
-
-
-
-
- Gets or sets the handler that is responsible for loading the image
- data for external graphics.
-
-
- If null is returned from the image handler, then Apoc will perform
- normal processing.
-
-
-
-
- Gets or sets the time in milliseconds until an HTTP image request
- times out.
-
-
- The default value is 100000 milliseconds.
-
-
- The timeout value in milliseconds
-
-
-
-
- Gets a reference to a object
- that manages credentials for multiple Internet resources.
-
-
-
- The purpose of this property is to associate a set of credentials against
- an Internet resource. These credentials are then used by Apoc when
- fetching images from one of the listed resources.
-
-
- ApocDriver driver = ApocDriver.Make();
-
- NetworkCredential nc1 = new NetworkCredential("foo", "password");
- driver.Credentials.Add(new Uri("http://www.chive.com"), "Basic", nc1);
-
- NetworkCredential nc2 = new NetworkCredential("john", "password", "UK");
- driver.Credentials.Add(new Uri("http://www.xyz.com"), "Digest", nc2);
-
-
-
-
- Write only property that can be used to bypass licenses.licx
- and set a product key directly.
-
-
-
-
- Returns the product key.
-
-
-
-
- Options that are passed to the rendering engine.
-
-
- An object that implements the marker interface.
- The default value is null, in which case all default options will be used.
-
-
- An instance of
- is typically passed to this property.
-
-
-
-
- True if the current license is an evaluation license.
-
-
-
-
- The delegate subscribers must implement to receive Apoc events.
-
-
- The parameter will be a reference to
- the active ApocDriver. The parameter will
- contain a human-readable error message.
-
- A reference to the active ApocDriver
- Encapsulates a human readable error message
-
-
-
- The delegat subscribers must implement to handle the loading
- of image data in response to external-graphic formatting objects.
-
-
-
-
- A class containing event data for the Error, Warning and Info
- events defined in .
-
-
-
-
- Initialises a new instance of the ApocEventArgs class.
-
- The text of the event message.
-
-
-
- Retrieves the event message.
-
- A string which may be null.
-
-
-
- Converts this ApocEventArgs to a string.
-
-
- A string representation of this class which is identical
- to .
-
-
-
-
- This exception is thrown by Apoc when an error occurs.
-
-
-
-
- Initialises a new instance of the ApocException class.
-
-
- The property will be initialised
- to innerException.Message
-
-
- The exception that is the cause of the current exception
-
-
-
-
- Initialises a new instance of the ApocException class.
-
-
- The error message that explains the reason for this exception
-
-
-
-
- Initialises a new instance of the ApocException class.
-
-
- The error message that explains the reason for this exception
-
-
- The exception that is the cause of the current exception
-
-
-
-
- A length quantity in XSL which is specified as "auto".
-
-
-
- a colour quantity in XSL
-
-
- the red component
-
-
- the green component
-
-
- the blue component
-
-
- the alpha component
-
-
- set the colour given a particular String specifying either a
- colour name or #RGB or #RRGGBB
-
-
- a space quantity in XSL (space-before, space-after)
-
-
- a length quantity in XSL
-
-
- Set the length given a number of relative units and the current
- font size in base units.
-
-
- Set the length given a number of units and a unit name.
-
-
- set the length as a number of base units
-
-
- Convert the given length to a dimensionless integer representing
- a whole number of base units (milli-points).
-
-
- Constructor for IDNode
-
- @param idValue The value of the id for this node
-
-
- Sets the page number for this node
-
- @param number page number of node
-
-
- Returns the page number of this node
-
- @return page number of this node
-
-
- creates a new GoTo object for an internal link
-
- @param objectNumber
- the number to be assigned to the new object
-
-
- sets the page reference for the internal link's GoTo. The GoTo will jump to this page reference.
-
- @param pageReference
- the page reference to which the internal link GoTo should jump
- ex. 23 0 R
-
-
- Returns the reference to the Internal Link's GoTo object
-
- @return GoTo object reference
-
-
- Returns the id value of this node
-
- @return this node's id value
-
-
- Returns the PDFGoTo object associated with the internal link
-
- @return PDFGoTo object
-
-
- Determines whether there is an internal link GoTo for this node
-
- @return true if internal link GoTo for this node is set, false otherwise
-
-
- Sets the position of this node
-
- @param x the x position
- @param y the y position
-
-
- Constructor for IDReferences
-
-
- Creates and configures the specified id.
-
- @param id The id to initialize
- @param area The area where this id was encountered
- @exception ApocException
-
-
- Creates id entry
-
- @param id The id to create
- @param area The area where this id was encountered
- @exception ApocException
-
-
- Creates id entry that hasn't been validated
-
- @param id The id to create
- @exception ApocException
-
-
- Adds created id list of unvalidated ids that have already
- been created. This should be used if it is unsure whether
- the id is valid but it must be anyhow.
-
- @param id The id to create
-
-
- Removes id from list of unvalidated ids.
- This should be used if the id has been determined
- to be valid.
-
- @param id The id to remove
-
-
- Determines whether specified id already exists in
- idUnvalidated
-
- @param id The id to search for
- @return true if ID was found, false otherwise
-
-
- Configures this id
-
- @param id The id to configure
- @param area The area where the id was encountered
-
-
- Adds id to validation list to be validated . This should be used if it is unsure whether the id is valid
-
- @param id id to be added
-
-
- Removes id from validation list. This should be used if the id has been determined to be valid
-
- @param id the id to remove
-
-
- Removes id from IDReferences
-
- @param id The id to remove
- @exception ApocException
-
-
- Determines whether all id's are valid
-
- @return true if all id's are valid, false otherwise
-
-
- Returns all invalid id's still remaining in the validation list
-
- @return invalid ids from validation list
-
-
- Determines whether specified id already exists in IDReferences
-
- @param id the id to search for
- @return true if ID was found, false otherwise
-
-
- Determines whether the GoTo reference for the specified id is defined
-
- @param id the id to search for
- @return true if GoTo reference is defined, false otherwise
-
-
- Returns the reference to the GoTo object used for the internal link
-
- @param id the id whose reference to use
- @return reference to GoTo object
-
-
-
- Creates an PdfGoto object that will 'goto' the passed Id.
-
- The ID of the link's target.
- The PDF object id to use for the GoTo object.
-
- This method is a bit 'wrong'. Passing in an objectId seems a bit
- dirty and I don't see why an IDNode should be responsible for
- keeping track of the GoTo object that points to it. These decisions
- only seem to pollute this class with PDF specific code.
-
-
-
- Adds an id to IDReferences
-
- @param id the id to add
-
-
- Returns the PDFGoTo object for the specified id
-
- @param id the id for which the PDFGoTo to be retrieved is associated
- @return the PdfGoTo object associated with the specified id
-
-
- sets the page reference for the internal link's GoTo. The GoTo will jump to this page reference.
-
- @param pageReference
- the page reference to which the internal link GoTo should jump
- ex. 23 0 R
-
-
- Sets the page number for the specified id
-
- @param id The id whose page number is being set
- @param pageNumber The page number of the specified id
-
-
- Returns the page number where the specified id is found
-
- @param id The id whose page number to return
- @return the page number of the id, or null if the id does not exist
-
-
- Sets the x and y position of specified id
-
- @param id the id whose position is to be set
- @param x x position of id
- @param y y position of id
-
-
- XSL FO Keep Property datatype (keep-together, etc)
-
-
- What to do here? There isn't really a meaningful single value.
-
-
- Keep Value
- Stores the different types of keeps in a single convenient format.
-
-
- FO parent of the FO for which this property is to be calculated.
-
-
- PropertyList for the FO where this property is calculated.
-
-
- One of the defined types of LengthBase
-
-
- Accessor for parentFO object from subclasses which define
- custom kinds of LengthBase calculations.
-
-
- Accessor for propertyList object from subclasses which define
- custom kinds of LengthBase calculations.
-
-
- This datatype hold a pair of lengths, specifiying the dimensions in
- both inline and block-progression-directions.
- It is currently only used to specify border-separation in tables.
-
-
- a "progression-dimension" quantity
- ex. block-progression-dimension, inline-progression-dimension
- corresponds to the triplet min-height, height, max-height (or width)
-
-
- Set minimum value to min.
- @param min A Length value specifying the minimum value for this
- LengthRange.
- @param bIsDefault If true, this is set as a "default" value
- and not a user-specified explicit value.
-
-
- Set maximum value to max if it is >= optimum or optimum isn't set.
- @param max A Length value specifying the maximum value for this
- @param bIsDefault If true, this is set as a "default" value
- and not a user-specified explicit value.
-
-
- Set the optimum value.
- @param opt A Length value specifying the optimum value for this
- @param bIsDefault If true, this is set as a "default" value
- and not a user-specified explicit value.
-
-
- Return the computed value in millipoints.
-
-
- A length quantity in XSL which is specified with a mixture
- of absolute and relative and/or percent components.
- The actual value may not be computable before layout is done.
-
-
- a percent specified length quantity in XSL
-
-
- construct an object based on a factor (the percent, as a
- a factor) and an object which has a method to return the
- Length which provides the "base" for this calculation.
-
-
- Return the computed value in millipoints. This assumes that the
- base length has been resolved to an absolute length value.
-
-
-
- A space quantity in XSL (space-before, space-after)
-
-
-
- A table-column width specification, possibly including some
- number of proportional "column-units". The absolute size of a
- column-unit depends on the fixed and proportional sizes of all
- columns in the table, and on the overall size of the table.
- It can't be calculated until all columns have been specified and until
- the actual width of the table is known. Since this can be specified
- as a percent of its parent containing width, the calculation is done
- during layout.
- NOTE: this is only supposed to be allowed if table-layout=fixed.
-
-
- Number of table-column proportional units
-
-
- Construct an object with tcolUnits of proportional measure.
-
-
- Override the method in Length to return the number of specified
- proportional table-column units.
-
-
- Calculate the number of millipoints and set it.
-
-
- The original specified value for properties which inherit
- specified values.
-
-
- Accessor functions for all possible Property datatypes
-
-
-
- Gets or setd the original value specified for the property attribute.
-
-
-
-
- Construct an instance of a PropertyMaker.
-
-
- The property name is set to "UNKNOWN".
-
-
-
-
- Construct an instance of a PropertyMaker for the given property.
-
- The name of the property to be made.
-
-
-
- Default implementation of isInherited.
-
- A boolean indicating whether this property is inherited.
-
-
-
- Return a boolean indicating whether this property inherits the
- "specified" value rather than the "computed" value. The default is
- to inherit the "computed" value.
-
- If true, property inherits the value specified.
-
-
-
- Return an object implementing the PercentBase interface. This is
- used to handle properties specified as a percentage of some "base
- length", such as the content width of their containing box.
- Overridden by subclasses which allow percent specifications. See
- the documentation on properties.xsl for details.
-
-
-
-
-
-
-
- Return a Maker object which is used to set the values on components
- of compound property types, such as "space". Overridden by property
- maker subclasses which handle compound properties.
-
-
- The name of the component for which a Maker is to returned, for
- example "optimum", if the FO attribute is space.optimum='10pt'.
-
-
-
-
-
- Return a property value for the given component of a compound
- property.
-
-
- NOTE: this is only to ease porting when calls are made to
- PropertyList.get() using a component name of a compound property,
- such as get("space.optimum").
- The recommended technique is: get("space").getOptimum().
- Overridden by property maker subclasses which handle compound properties.
-
- A property value for a compound property type such as SpaceProperty.
- The name of the component whose value is to be returned.
-
-
-
-
- Return a property value for a compound property. If the property
- value is already partially initialized, this method will modify it.
-
-
- The Property object representing the compound property, such as
- SpaceProperty.
-
- The name of the component whose value is specified.
- The propertyList being built.
-
- The FO whose properties are being set.
- A compound property object.
-
-
-
- Set a component in a compound property and return the modified
- compound property object. This default implementation returns
- the original base property without modifying it. It is overridden
- by property maker subclasses which handle compound properties.
-
-
- The Property object representing the compound property, such as SpaceProperty.
-
- The name of the component whose value is specified.
-
- A Property object holding the specified value of the component to be set.
-
- The modified compound property object.
-
-
-
- Create a Property object from an attribute specification.
-
- The PropertyList object being built for this FO.
- The attribute value.
- The current FO whose properties are being set.
- The initialized Property object.
-
-
-
- Return a String to be parsed if the passed value corresponds to
- a keyword which can be parsed and used to initialize the property.
- For example, the border-width family of properties can have the
- initializers "thin", "medium", or "thick". The foproperties.xml
- file specifies a length value equivalent for these keywords,
- such as "0.5pt" for "thin". These values are considered parseable,
- since the Length object is no longer responsible for parsing
- unit expresssions.
-
- The string value of property attribute.
-
- A string containging a parseable equivalent or null if the passed
- value isn't a keyword initializer for this Property.
-
-
-
-
- Return a Property object based on the passed Property object.
- This method is called if the Property object built by the parser
- isn't the right type for this property.
- It is overridden by subclasses when the property specification in
- foproperties.xml specifies conversion rules.
-
- The Property object return by the expression parser
- The PropertyList object being built for this FO.
- The current FO whose properties are being set.
-
- A Property of the correct type or null if the parsed value
- can't be converted to the correct type.
-
-
-
-
- Return a Property object representing the initial value.
-
- The PropertyList object being built for this FO.
-
-
-
-
- Return a Property object representing the initial value.
-
- The PropertyList object being built for this FO.
- The parent FO for the FO whose property is being made.
-
- A Property subclass object holding a "compound" property object
- initialized to the default values for each component.
-
-
-
-
- Return a Property object representing the value of this property,
- based on other property values for this FO.
- A special case is properties which inherit the specified value,
- rather than the computed value.
-
- The PropertyList for the FO.
-
- Property A computed Property value or null if no rules are
- specified (in foproperties.xml) to compute the value.
-
-
-
-
- Return the name of the property whose value is being set.
-
-
-
- base class for extension objects
-
-
- base class for representation of formatting objects and their processing
-
-
-
- Value of marker before layout begins
-
-
-
- value of marker after break-after
-
-
- where the layout was up to.
- for FObjs it is the child number
- for FOText it is the character number
-
-
- lets outside sources access the property list
- first used by PageNumberCitation to find the "id" property
- returns null by default, overide this function when there is a property list
- @param name - the name of the desired property to obtain
- @returns the property
-
-
- At the start of a new span area layout may be partway through a
- nested FO, and balancing requires rollback to this known point.
- The snapshot records exactly where layout is at.
- @param snapshot a Vector of markers (Integer)
- @returns the updated Vector of markers (Integers)
-
-
- When balancing occurs, the flow layout() method restarts at the
- point specified by the current marker snapshot, which is retrieved
- and restored using this method.
- @param snapshot the Vector of saved markers (Integers)
-
-
- adds characters (does nothing here)
- @param data text
- @param start start position
- @param length length of the text
-
-
- generates the area or areas for this formatting object
- and adds these to the area. This method should always be
- overridden by all sub classes
-
- @param area
-
-
- returns the name of the formatting object
- @return the name of this formatting objects
-
-
-
-
-
-
-
-
- lets outside sources access the property list
- first used by PageNumberCitation to find the "id" property
- @param name - the name of the desired property to obtain
- @return the property
-
-
- Return the "content width" of the areas generated by this FO.
- This is used by percent-based properties to get the dimension of
- the containing block.
- If an FO has a property with a percentage value, that value
- is usually calculated on the basis of the corresponding dimension
- of the area which contains areas generated by the FO.
- NOTE: subclasses of FObj should implement this to return a reasonable
- value!
-
-
- removes property id
- @param idReferences the id to remove
-
-
- Set writing mode for this FO.
- Find nearest ancestor, including self, which generates
- reference areas and use the value of its writing-mode property.
- If no such ancestor is found, use the value on the root FO.
-
-
-
- @param parent the parent formatting object
- @param propertyList the explicit properties of this object
-
-
- Called for extensions within a page sequence or flow. These extensions
- are allowed to generate visible areas within the layout.
-
-
- @param area
-
-
- Called for root extensions. Root extensions aren't allowed to generate
- any visible areas. They are used for extra items that don't show up in
- the page layout itself. For example: pdf outlines
-
- @param areaTree
-
-
- The parent outline object if it exists
-
-
- an opaque renderer context object, e.g. PDFOutline for PDFRenderer
-
-
- The fo:root formatting object. Contains page masters, root extensions,
- page-sequences.
-
-
- Called by subclass if no match found.
-
-
- By default, functions have no percent-based arguments.
-
-
- Return the specified or initial value of the property on this object.
-
-
- Return the name as a String (should be specified with quotes!)
-
-
- Construct a Numeric object from a Number.
- @param num The number.
-
-
- Construct a Numeric object from a Length.
- @param l The Length.
-
-
- Construct a Numeric object from a PercentLength.
- @param pclen The PercentLength.
-
-
- v * Construct a Numeric object from a TableColLength.
- * @param tclen The TableColLength.
-
-
- Return the current value as a Length if possible. This constructs
- a new Length or Length subclass based on the current value type
- of the Numeric.
- If the stored value has a unit dimension other than 1, null
- is returned.
-
-
- Return the current value as a Number if possible.
- Calls asDouble().
-
-
- Return a boolean value indiciating whether the currently stored
- value consists of different "types" of values (absolute, percent,
- and/or table-unit.)
-
-
- Subtract the operand from the current value and return a new Numeric
- representing the result.
- @param op The value to subtract.
- @return A Numeric representing the result.
- @throws PropertyException If the dimension of the operand is different
- from the dimension of this Numeric.
-
-
- Add the operand from the current value and return a new Numeric
- representing the result.
- @param op The value to add.
- @return A Numeric representing the result.
- @throws PropertyException If the dimension of the operand is different
- from the dimension of this Numeric.
-
-
- Multiply the the current value by the operand and return a new Numeric
- representing the result.
- @param op The multiplier.
- @return A Numeric representing the result.
- @throws PropertyException If both Numerics have "mixed" type.
-
-
- Divide the the current value by the operand and return a new Numeric
- representing the result.
- @param op The divisor.
- @return A Numeric representing the result.
- @throws PropertyException If both Numerics have "mixed" type.
-
-
- Return the absolute value of this Numeric.
- @return A new Numeric object representing the absolute value.
-
-
- Return a Numeric which is the maximum of the current value and the
- operand.
- @throws PropertyException If the dimensions or value types of the
- object and the operand are different.
-
-
- Return a Numeric which is the minimum of the current value and the
- operand.
- @throws PropertyException If the dimensions or value types of the
- object and the operand are different.
-
-
- This class holds context information needed during property expression
- evaluation.
- It holds the Maker object for the property, the PropertyList being
- built, and the FObj parent of the FObj for which the property is being set.
-
-
- Return whether this property inherits specified values.
- Propagates to the Maker.
- @return true if the property inherits specified values, false if it
- inherits computed values.
-
-
- Return the PercentBase object used to calculate the absolute value from
- a percent specification.
- Propagates to the Maker.
- @return The PercentBase object or null if percentLengthOK()=false.
-
-
- Return the current font-size value as base units (milli-points).
-
-
- Construct a new PropertyTokenizer object to tokenize the passed
- string.
- @param s The Property expressio to tokenize.
-
-
- Return the next token in the expression string.
- This sets the following package visible variables:
- currentToken An enumerated value identifying the recognized token
- currentTokenValue A string containing the token contents
- currentUnitLength If currentToken = TOK_NUMERIC, the number of
- characters in the unit name.
- @throws PropertyException If un unrecognized token is encountered.
-
-
- Attempt to recognize a valid NAME token in the input expression.
-
-
- Attempt to recognize a valid sequence of decimal digits in the
- input expression.
-
-
- Attempt to recognize a valid sequence of hexadecimal digits in the
- input expression.
-
-
- Return a bool value indicating whether the following non-whitespace
- character is an opening parenthesis.
-
-
- Return a bool value indicating whether the argument is a
- decimal digit (0-9).
- @param c The character to check
-
-
- Return a bool value indicating whether the argument is a
- hexadecimal digit (0-9, A-F, a-f).
- @param c The character to check
-
-
- Return a bool value indicating whether the argument is whitespace
- as defined by XSL (space, newline, CR, tab).
- @param c The character to check
-
-
- Return a bool value indicating whether the argument is a valid name
- start character, ie. can start a NAME as defined by XSL.
- @param c The character to check
-
-
- Return a bool value indicating whether the argument is a valid name
- character, ie. can occur in a NAME as defined by XSL.
- @param c The character to check
-
-
- Public entrypoint to the Property expression parser.
- @param expr The specified value (attribute on the xml element).
- @param propInfo A PropertyInfo object representing the context in
- which the property expression is to be evaluated.
- @return A Property object holding the parsed result.
- @throws PropertyException If the "expr" cannot be parsed as a Property.
-
-
- Private constructor. Called by the static parse() method.
- @param propExpr The specified value (attribute on the xml element).
- @param propInfo A PropertyInfo object representing the context in
- which the property expression is to be evaluated.
-
-
- Parse the property expression described in the instance variables.
- Note: If the property expression String is empty, a StringProperty
- object holding an empty String is returned.
- @return A Property object holding the parsed result.
- @throws PropertyException If the "expr" cannot be parsed as a Property.
-
-
- Try to parse an addition or subtraction expression and return the
- resulting Property.
-
-
- Try to parse a multiply, divide or modulo expression and return
- the resulting Property.
-
-
- Try to parse a unary minus expression and return the
- resulting Property.
-
-
- Checks that the current token is a right parenthesis
- and throws an exception if this isn't the case.
-
-
- Try to parse a primary expression and return the
- resulting Property.
- A primary expression is either a parenthesized expression or an
- expression representing a primitive Property datatype, such as a
- string literal, an NCname, a number or a unit expression, or a
- function call expression.
-
-
- Parse a comma separated list of function arguments. Each argument
- may itself be an expression. This method consumes the closing right
- parenthesis of the argument list.
- @param nbArgs The number of arguments expected by the function.
- @return An array of Property objects representing the arguments
- found.
- @throws PropertyException If the number of arguments found isn't equal
- to the number expected.
-
-
- Evaluate an addition operation. If either of the arguments is null,
- this means that it wasn't convertible to a Numeric value.
- @param op1 A Numeric object (Number or Length-type object)
- @param op2 A Numeric object (Number or Length-type object)
- @return A new NumericProperty object holding an object which represents
- the sum of the two operands.
- @throws PropertyException If either operand is null.
-
-
- Evaluate a subtraction operation. If either of the arguments is null,
- this means that it wasn't convertible to a Numeric value.
- @param op1 A Numeric object (Number or Length-type object)
- @param op2 A Numeric object (Number or Length-type object)
- @return A new NumericProperty object holding an object which represents
- the difference of the two operands.
- @throws PropertyException If either operand is null.
-
-
- Evaluate a unary minus operation. If the argument is null,
- this means that it wasn't convertible to a Numeric value.
- @param op A Numeric object (Number or Length-type object)
- @return A new NumericProperty object holding an object which represents
- the negative of the operand (multiplication by *1).
- @throws PropertyException If the operand is null.
-
-
- Evaluate a multiplication operation. If either of the arguments is null,
- this means that it wasn't convertible to a Numeric value.
- @param op1 A Numeric object (Number or Length-type object)
- @param op2 A Numeric object (Number or Length-type object)
- @return A new NumericProperty object holding an object which represents
- the product of the two operands.
- @throws PropertyException If either operand is null.
-
-
- Evaluate a division operation. If either of the arguments is null,
- this means that it wasn't convertible to a Numeric value.
- @param op1 A Numeric object (Number or Length-type object)
- @param op2 A Numeric object (Number or Length-type object)
- @return A new NumericProperty object holding an object which represents
- op1 divided by op2.
- @throws PropertyException If either operand is null.
-
-
- Evaluate a modulo operation. If either of the arguments is null,
- this means that it wasn't convertible to a Number value.
- @param op1 A Number object
- @param op2 A Number object
- @return A new NumberProperty object holding an object which represents
- op1 mod op2.
- @throws PropertyException If either operand is null.
-
-
-
- Parses a double value using a culture insensitive locale.
-
- The double value as a string.
- The double value parsed.
-
-
- Return an object which implements the PercentBase interface.
- Percents in arguments to this function are interpreted relative
- to 255.
-
-
- Return true if the passed area is on the left edge of its nearest
- absolute AreaContainer (generally a page column).
-
-
- base class for representation of mixed content formatting objects
- and their processing
-
-
- Return the content width of the boxes generated by this FO.
-
-
- Return the content width of the boxes generated by this block
- container FO.
-
-
- this class represents the flow object 'fo:character'. Its use is defined by
- the spec: "The fo:character flow object represents a character that is mapped to
- a glyph for presentation. It is an atomic unit to the formatter.
- When the result tree is interpreted as a tree of formatting objects,
- a character in the result tree is treated as if it were an empty
- element of type fo:character with a character attribute
- equal to the Unicode representation of the character.
- The semantics of an "auto" value for character properties, which is
- typically their initial value, are based on the Unicode codepoint.
- Overrides may be specified in an implementation-specific manner." (6.6.3)
-
-
-
- PageSequence container
-
-
- Vector to store snapshot
-
-
- flow-name attribute
-
-
- Content-width of current column area during layout
-
-
- Return the content width of this flow (really of the region
- in which it is flowing).
-
-
- returns the maker for this object.
-
- @return the maker for SVG objects
-
-
- constructs an instream-foreign-object object (called by Maker).
-
- @param parent the parent formatting object
- @param propertyList the explicit properties of this object
-
-
- layout this formatting object.
-
- @param area the area to layout the object into
-
- @return the status of the layout
-
-
- inner class for making SVG objects.
-
-
- make an SVG object.
-
- @param parent the parent formatting object
- @param propertyList the explicit properties of this object
-
- @return the SVG object
-
-
- Implements fo:leader; main property of leader leader-pattern.
- The following patterns are treated: rule, space, dots.
- The pattern use-content is ignored, i.e. it still must be implemented.
-
-
- adds a leader to current line area of containing block area
- the actual leader area is created in the line area
-
- @return int +1 for success and -1 for none
-
-
- Return the content width of the boxes generated by this FO.
-
-
-
- The page the marker was registered is put into the renderer
- queue. The marker is transferred to it's own marker list,
- release the area for GC. We also know now whether the area is
- first/last.
-
-
-
-
- This has actually nothing to do with resseting this marker,
- but the 'marker' from FONode, marking layout status.
- Called in case layout is to be rolled back. Unregister this
- marker from the page, it isn't laid aout anyway.
-
-
-
-
- More hackery: reset layout status marker. Called before the
- content is laid out from RetrieveMarker.
-
-
-
- 6.6.11 fo:page-number-citation
-
- Common Usage:
- The fo:page-number-citation is used to reference the page-number for the page containing the first normal area returned by
- the cited formatting object.
-
- NOTE:
- It may be used to provide the page-numbers in the table of contents, cross-references, and index entries.
-
- Areas:
- The fo:page-number-citation formatting object generates and returns a single normal inline-area.
- Constraints:
-
- The cited page-number is the number of the page containing, as a descendant, the first normal area returned by the
- formatting object with an id trait matching the ref-id trait of the fo:page-number-citation (the referenced formatting
- object).
-
- The cited page-number string is obtained by converting the cited page-number in accordance with the number to string
- conversion properties specified on the ancestor fo:page-sequence of the referenced formatting object.
-
- The child areas of the generated inline-area are the same as the result of formatting a result-tree fragment consisting of
- fo:character flow objects; one for each character in the cited page-number string and with only the "character" property
- specified.
-
- Contents:
-
- EMPTY
-
- The following properties apply to this formatting object:
-
- [7.3 Common Accessibility Properties]
- [7.5 Common Aural Properties]
- [7.6 Common Border, Padding, and Background Properties]
- [7.7 Common Font Properties]
- [7.10 Common Margin Properties-Inline]
- [7.11.1 "alignment-adjust"]
- [7.11.2 "baseline-identifier"]
- [7.11.3 "baseline-shift"]
- [7.11.5 "dominant-baseline"]
- [7.36.2 "id"]
- [7.17.4 "keep-with-next"]
- [7.17.5 "keep-with-previous"]
- [7.14.2 "letter-spacing"]
- [7.13.4 "line-height"]
- [7.13.5 "line-height-shift-adjustment"]
- [7.36.5 "ref-id"]
- [7.18.4 "relative-position"]
- [7.36.6 "score-spaces"]
- [7.14.4 "text-decoration"]
- [7.14.5 "text-shadow"]
- [7.14.6 "text-transform"]
- [7.14.8 "word-spacing"]
-
-
- Return true if any column has an unfinished vertical span.
-
-
- Done with a row.
- Any spans with only one row left are done
- This means that we can now set the total height for this cell box
- Loop over all cells with spans and find number of rows remaining
- if rows remaining = 1, set the height on the cell area and
- then remove the cell from the list of spanned cells. For other
- spans, add the rowHeight to the spanHeight.
-
-
- If the cell in this column is in the last row of its vertical
- span, return the height left. If it's not in the last row, or if
- the content height <= the content height of the previous rows
- of the span, return 0.
-
-
- helper method to prevent infinite loops if
- keeps or spans are not fitting on a page
- @param true if keeps and spans should be ignored
-
-
- helper method (i.e. hack ;-) to prevent infinite loops if
- keeps or spans are not fitting on a page
- @return true if keeps or spans should be ignored
-
-
- Return the height remaining in the span.
-
-
- Optimum inline-progression-dimension
-
-
- Minimum inline-progression-dimension
-
-
- Maximum inline-progression-dimension
-
-
- Return the content width of the boxes generated by this table FO.
-
-
- Initialize table inline-progression-properties values
-
-
- Offset of content rectangle in inline-progression-direction,
- relative to table.
-
-
- Dimension of allocation rectangle in inline-progression-direction,
- determined by the width of the column(s) occupied by the cell
-
-
- Offset of content rectangle, in block-progression-direction,
- relative to the row.
-
-
- Offset of content rectangle, in inline-progression-direction,
- relative to the column start edge.
-
-
- Adjust to theoretical column width to obtain content width
- relative to the column start edge.
-
-
- Minimum ontent height of cell.
-
-
- Set to true if all content completely laid out.
-
-
- Border separation value in the block-progression dimension.
- Used in calculating cells height.
-
-
- Return the allocation height of the cell area.
- Note: called by TableRow.
- We adjust the actual allocation height of the area by the value
- of border separation (for separate borders) or border height
- adjustment for collapse style (because current scheme makes cell
- overestimate the allocation height).
-
-
- Set the final size of cell content rectangles to the actual row height
- and to vertically align the actual content within the cell rectangle.
- @param h Height of this row in the grid which is based on
- the allocation height of all the cells in the row, including any
- border separation values.
-
-
- Calculate cell border and padding, including offset of content
- rectangle from the theoretical grid position.
-
-
- Set the column width value in base units which overrides the
- value from the column-width Property.
-
-
- Called by parent FO to initialize information about
- cells started in previous rows which span into this row.
- The layout operation modifies rowSpanMgr
-
-
- Before starting layout for the first time, initialize information
- about spanning rows, empty cells and spanning columns.
-
-
- Return column which doesn't already contain a span or a cell
- If past the end or no free cells after colNum, return -1
- Otherwise return value >= input value.
-
-
- Return type of cell in colNum (1 based)
-
-
- Return cell in colNum (1 based)
-
-
- Store cell starting at cellColNum (1 based) and spanning numCols
- If any of the columns is already occupied, return false, else true
-
-
- Implementation for fo:wrapper formatting object.
- The wrapper object serves as
- a property holder for it's children objects.
-
- Content: (#PCDATA|%inline;|%block;)*
- Properties: id
-
-
-
- Builds the formatting object tree.
-
-
-
-
- Table mapping element names to the makers of objects
- representing formatting objects.
-
-
-
-
- Class that builds a property list for each formatting object.
-
-
-
-
- Current formatting object being handled.
-
-
-
-
- The root of the formatting object tree.
-
-
-
-
- Set of names of formatting objects encountered but unknown.
-
-
-
-
- The class that handles formatting and rendering to a stream.
-
-
-
-
- Sets the stream renderer that will be used as output.
-
-
-
-
- Add a mapping from element name to maker.
-
-
-
-
- Add a mapping from property name to maker.
-
-
-
- This object may be also be a subclass of Length, such
- as PercentLength, TableColLength.
-
-
- public Double getDouble() {
- return new Double(this.number.doubleValue());
- }
- public Integer getInteger() {
- return new Integer(this.number.intValue());
- }
-
-
- Returns the "master-reference" attribute of this page master reference
-
-
- Checks whether or not a region name exists in this master set
- @returns true when the region name specified has a region in this LayoutMasterSet
-
-
- Base PageMasterReference class. Provides implementation for handling the
- master-reference attribute and containment within a PageSequenceMaster
-
-
- Classes that implement this interface can be added to a PageSequenceMaster,
- and are capable of looking up an appropriate PageMaster.
-
-
- Called before a new page sequence is rendered so subsequences can reset
- any state they keep during the formatting process.
-
-
- Gets the formating object name for this object. Subclasses must provide this.
-
- @return the element name of this reference. e.g. fo:repeatable-page-master-reference
-
-
- Checks that the parent is the right element. The default implementation
- checks for fo:page-sequence-master
-
-
- Returns the "master-reference" attribute of this page master reference
-
-
- This class uses the 'format', 'groupingSeparator', 'groupingSize',
- and 'letterValue' properties on fo:page-sequence to return a string
- corresponding to the supplied integer page number.
-
-
- This provides pagination of flows onto pages. Much of the logic for paginating
- flows is contained in this class. The main entry point is the format method.
-
-
- The parent root object
-
-
- the set of layout masters (provided by the root object)
-
-
- Map of flows to their flow name (flow-name, Flow)
-
-
- the "master-reference" attribute,
- which specifies the name of the page-sequence-master or
- page-master to be used to create pages in the sequence
-
-
- specifies page numbering type (auto|auto-even|auto-odd|explicit)
-
-
- used to determine whether to calculate auto, auto-even, auto-odd
-
-
- the current subsequence while formatting a given page sequence
-
-
- the current index in the subsequence list
-
-
- the name of the current page master
-
-
- Runs the formatting of this page sequence into the given area tree
-
-
- Creates a new page area for the given parameters
- @param areaTree the area tree the page should be contained in
- @param firstAvailPageNumber the page number for this page
- @param isFirstPage true when this is the first page in the sequence
- @param isEmptyPage true if this page will be empty (e.g. forced even or odd break)
- @return a Page layout object based on the page master selected from the params
-
-
- Formats the static content of the current page
-
-
- Returns the next SubSequenceSpecifier for the given page sequence master. The result
- is bassed on the current state of this page sequence.
-
-
- Returns the next simple page master for the given sequence master, page number and
- other state information
-
-
- Returns true when there is more flow elements left to lay out.
-
-
- Returns the flow that maps to the given region class for the current
- page master.
-
-
- This is an abstract base class for pagination regions
-
-
- Creates a Region layout object for this pagination Region.
-
-
- Returns the default region name (xsl-region-before, xsl-region-start,
- etc.)
-
-
- Returns the element name ("fo:region-body", "fo:region-start",
- etc.)
-
-
- Returns the name of this region
-
-
- Checks to see if a given region name is one of the reserved names
-
- @param name a region name to check
- @return true if the name parameter is a reserved region name
-
-
- Max times this page master can be repeated.
- INFINITE is used for the unbounded case
-
-
- The fo:root formatting object. Contains page masters, root extensions,
- page-sequences.
-
-
- keeps count of page number from over PageSequence instances
-
-
- Some properties, such as 'force-page-count', require a
- page-sequence to know about some properties of the next.
- @returns succeeding PageSequence; null if none
-
-
- Page regions (regionClass, Region)
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Set the appropriate components when the "base" property is set.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return object used to calculate base Length
- for percent specifications.
-
-
- Return the value explicitly specified on this FO.
- @param propertyName The name of the property whose value is desired.
- It may be a compound name, such as space-before.optimum.
- @return The value if the property is explicitly set or set by
- a shorthand property, otherwise null.
-
-
- Return the value explicitly specified on this FO.
- @param propertyName The name of the property whose value is desired.
- It may be a compound name, such as space-before.optimum.
- @return The value if the property is explicitly set, otherwise null.
-
-
- Return the value explicitly specified on this FO.
- @param propertyName The name of the base property whose value is desired.
- @return The value if the property is explicitly set, otherwise null.
-
-
- Return the value of this property inherited by this FO.
- Implements the inherited-property-value function.
- The property must be inheritable!
- @param propertyName The name of the property whose value is desired.
- @return The inherited value, otherwise null.
-
-
- Return the property on the current FlowObject if it is specified, or if a
- corresponding property is specified. If neither is specified, it returns null.
-
-
- Return the property on the current FlowObject. If it isn't set explicitly,
- this will try to compute it based on other properties, or if it is
- inheritable, to return the inherited value. If all else fails, it returns
- the default value.
-
-
- Return the property on the current FlowObject. Depending on the passed flags,
- this will try to compute it based on other properties, or if it is
- inheritable, to return the inherited value. If all else fails, it returns
- the default value.
-
-
- Return the "nearest" specified value for the given property.
- Implements the from-nearest-specified-value function.
- @param propertyName The name of the property whose value is desired.
- @return The computed value if the property is explicitly set on some
- ancestor of the current FO, else the initial value.
-
-
- Return the value of this property on the parent of this FO.
- Implements the from-parent function.
- @param propertyName The name of the property whose value is desired.
- @return The computed value on the parent or the initial value if this
- FO is the root or is in a different namespace from its parent.
-
-
- Given an absolute direction (top, bottom, left, right),
- return the corresponding writing model relative direction name
- for the flow object. Uses the stored writingMode.
-
-
- Given a writing mode relative direction (start, end, before, after)
- return the corresponding absolute direction name
- for the flow object. Uses the stored writingMode.
-
-
- Set the writing mode traits for the FO with this property list.
-
-
- Name of font-size property attribute to set first.
-
-
-
- This seems to be just a helper method that looks up a property maker and
- creates the property.
-
-
-
-
- Convenience function to return the Maker for a given property.
-
-
-
- classes representating the status of laying out a formatting object
-
-
- This represents an unknown element.
- For example with unsupported namespaces.
- This prevents any further problems arising from the unknown
- data.
-
-
- returns the maker for this object.
-
- @return the maker for an unknown xml object
-
-
- constructs an unknown xml object (called by Maker).
-
- @param parent the parent formatting object
- @param propertyList the explicit properties of this object
-
-
- inner class for making unknown xml objects.
-
-
- make an unknown xml object.
-
- @param parent the parent formatting object
- @param propertyList the explicit properties of this object
-
- @return the unknown xml object
-
-
-
- A bitmap image that will be referenced by fo:external-graphic.
-
-
- This class and the associated ColorSpace class are PDF specific ideally
- will be moved to the PDF library project at some point in the future.
- Internally, Apoc should handle images using the standard framework
- Bitmap class.
-
-
-
-
- Filter that will be applied to image data
-
-
-
-
- Constructs a new ApocImage using the supplied bitmap.
-
-
- Does not hold a reference to the passed bitmap. Instead the
- image data is extracted from bitmap on construction.
-
- The location of bitmap
- The image data
-
-
-
- Extracts the raw data from the image into a byte array suitable
- for including in the PDF document. The image is always extracted
- as a 24-bit RGB image, regardless of it's original colour space
- and colour depth.
-
- The from which the data is extracted
- A byte array containing the raw 24-bit RGB data
-
-
-
- Return the image URL.
-
- the image URL (as a string)
-
-
-
- Return the image width.
-
- the image width
-
-
-
- Return the image height.
-
- the image height
-
-
-
- Return the number of bits per pixel.
-
- number of bits per pixel
-
-
-
- Return the image data size
-
- The image data size
-
-
-
- Return the image data (uncompressed).
-
- the image data
-
-
-
- Return the image color space.
-
- the image color space (Apoc.Datatypes.ColorSpace)
-
-
-
- Returns the implementation
- that should be applied to the bitmap data.
-
-
-
-
- Creates ApocImage instances.
-
-
-
-
- Creates a ApocImage from the supplied resource locator. The
- ApocImageFactory does cache images, therefore this method may
- return a reference to an existing ApocImage
-
- A Uniform Resource Identifier
- A reference to a ApocImage
-
-
-
- Total height of content of this area.
-
-
- Creates a new Area instance.
-
- @param fontState a FontState value
- @param allocationWidth the inline-progression dimension of the content
- rectangle of the Area
- @param maxHeight the maximum block-progression dimension available
- for this Area (its allocation rectangle)
-
-
- Set the allocation width.
- @param w The new allocation width.
- This sets content width to the same value.
- Currently only called during layout of Table to set the width
- to the total width of all the columns. Note that this assumes the
- column widths are explicitly specified.
-
-
-
- Tell whether this area contains any children which are not
- DisplaySpace. This is used in determining whether to honour keeps.
-
-
-
-
- Returns content height of the area.
-
- @return Content height in millipoints
-
-
- Returns allocation height of this area.
- The allocation height is the sum of the content height plus border
- and padding in the vertical direction.
-
- @return allocation height in millipoints
-
-
-
- Return absolute Y position of the current bottom of this area,
- not counting any bottom padding or border.
-
-
- This is used to set positions for link hotspots.
- In fact, the position is not really absolute, but is relative
- to the Ypos of the column-level AreaContainer, even when the
- area is in a page header or footer!
-
-
-
-
- Set "absolute" Y position of the top of this area.
-
-
- In fact, the position is not really absolute, but relative to
- the Ypos of the column-level AreaContainer, even when the area
- is in a page header or footer!
- It is set from the value of getAbsoluteHeight() on the parent
- area, just before adding this area.
-
-
-
- Return space remaining in the vertical direction (height).
- This returns maximum available space - current content height
- Note: content height should be based on allocation height of content!
- @return space remaining in base units (millipoints)
-
-
- Set the content height to the passed value if that value is
- larger than current content height. If the new content height
- is greater than the maximum available height, set the content height
- to the max. available (!!!)
-
- @param height allocation height of content in millipoints
-
-
- amount of space added since the original layout - needed by links
-
-
-
- Parses the contents of a JPEG image header to infer the colour
- space and bits per pixel.
-
-
-
-
- JPEG image data
-
-
-
-
- Contains number of bitplanes, color space and optional ICC Profile
-
-
-
-
- Raw ICC Profile
-
-
-
-
- Class constructor.
-
-
-
-
-
-
-
-
-
-
- Reads a 16-bit integer from the underlying stream
-
-
-
-
-
- Reads a 32-bit integer from the underlying stream
-
-
-
-
-
- Reads the specified number of bytes from theunderlying stream
- and converts them to a string using the ASCII encoding.
-
-
-
-
-
-
- Reads the initial marker which should be SOI.
-
-
- After invoking this method the stream will point to the location
- immediately after the fiorst marker.
-
-
-
-
-
- Reads the next JPEG marker and returns its marker code.
-
-
-
-
-
- Skips over the parameters for any marker we don't want to process.
-
-
-
-
- Parses a <uri-specification> as defined by
- section 5.11 of the XSL specification.
-
-
- This class may be better expressed as a datatype residing in
- Telerik.Web.Apoc.DataTypes.
-
-
-
- Store all hyphenation related properties on an FO.
- Public "structure" allows direct member access.
-
-
- Store all hyphenation related properties on an FO.
- Public "structure" allows direct member access.
-
-
- object containing information on available fonts, including
- metrics
-
-
- List of root extension objects
-
-
-
- Auxillary function for retrieving markers.
-
-
-
-
-
- Auxillary function for retrieving markers.
-
-
-
-
-
- Auxillary function for retrieving markers.
-
-
-
-
- Store all hyphenation related properties on an FO.
- Public "structure" allows direct member access.
-
-
- This class represents a Block Area.
- A block area is made up of a sequence of Line Areas.
-
- This class is used to organise the sequence of line areas as
- inline areas are added to this block it creates and ands line areas
- to hold the inline areas.
- This uses the line-height and line-stacking-strategy to work
- out how to stack the lines.
-
-
- Add a Line Area to this block area.
- Used internally to add a completed line area to this block area
- when either a new line area is created or this block area is
- completed.
-
- @param la the LineArea to add
-
-
- Get the current line area in this block area.
- This is used to get the current line area for adding
- inline objects to.
- This will return null if there is not enough room left
- in the block area to accomodate the line area.
-
- @return the line area to be used to add inlie objects
-
-
- Create a new line area to add inline objects.
- This should be called after getting the current line area
- and discovering that the inline object will not fit inside the current
- line. This method will create a new line area to place the inline
- object into.
- This will return null if the new line cannot fit into the block area.
-
- @return the new current line area, which will be empty.
-
-
- Notify this block that the area has completed layout.
- Indicates the the block has been fully laid out, this will
- add (if any) the current line area.
-
-
- Return the maximum space remaining for this area's content in
- the block-progression-dimension.
- Remove top and bottom padding and spacing since these reduce
- available space for content and they are not yet accounted for
- in the positioning of the object.
-
-
- Depending on the column-count of the next FO, determine whether
- a new span area needs to be constructed or not, and return the
- appropriate ColumnArea.
- The next cut of this method should also inspect the FO to see
- whether the area to be returned ought not to be the footnote
- or before-float reference area.
- @param fo The next formatting object
- @returns the next column area (possibly the current one)
-
-
- Add a new span area with specified number of column areas.
- @param numColumns The number of column areas
- @returns AreaContainer The next column area
-
-
- This almost does what getNewArea() does, without actually
- returning an area. These 2 methods can be reworked.
- @param fo The next formatting object
- @returns bool True if we need to balance.
-
-
- This is where the balancing algorithm lives, or gets called.
- Right now it's primitive: get the total content height in all
- columns, divide by the column count, and add a heuristic
- safety factor.
- Then the previous (unbalanced) span area is removed, and a new
- one added with the computed max height.
-
-
- Determine remaining height for new span area. Needs to be
- modified for footnote and before-float reference areas when
- those are supported.
- @returns int The remaining available height in millipoints.
-
-
- Used by resetSpanArea() and addSpanArea() to adjust the main
- reference area height before creating a new span.
-
-
- Used in Flow when layout returns incomplete.
- @returns bool Is this the last column in this span?
-
-
- This variable is unset by getNextArea(), is set by addSpanArea(),
- and may be set by resetSpanArea().
- @returns bool Is the span area new or not?
-
-
- Return a full copy of the BorderAndPadding information. This clones all
- padding and border information.
- @return The copy.
-
-
- Creates a key from the given strings
-
-
-
- Class constructor
-
-
- Defaults the letter spacing to 0 millipoints.
-
-
-
-
- Gets width of given character identifier plus
- in millipoints (1/1000ths of a point).
-
-
-
-
-
-
- Map a Unicode character to a code point
-
- Any Unicode character.
-
-
-
- Store all hyphenation related properties on an FO.
- Public "structure" allows direct member access.
-
-
-
- A font descriptor specifies metrics and other attributes of a
- font, as distinct from the metrics of individual glyphs.
-
-
- See page 355 of PDF 1.4 specification for more information.
-
-
-
-
- Gets a collection of flags providing various font characteristics.
-
-
-
-
- Gets the smallest rectangle that will encompass the shape that
- would result if all glyhs of the font were placed with their
- origins coincident.
-
-
-
-
- Gets the main italic angle of the font expressed in tenths of
- a degree counterclockwise from the vertical.
-
-
-
-
- TODO: The thickness, measured horizontally, of the dominant vertical
- stems of the glyphs in the font.
-
-
-
-
- Gets a value that indicates whether this font has kerning support.
-
-
-
-
-
- Gets a value that indicates whether this font program may be legally
- embedded within a document.
-
-
-
-
-
- Gets a value that indicates whether this font program my be subsetted.
-
-
-
-
-
- Gets a byte array representing a font program to be embedded
- in a document.
-
-
- If is false it is acceptable
- for this method to return null.
-
-
-
-
- Gets kerning information for this font.
-
-
- If is false it is acceptable
- for this method to return null.
-
-
-
-
- Interface for font metric classes
-
-
-
-
- Gets the width of a character in 1/1000ths of a point size
- located at the supplied codepoint.
-
-
- For a type 1 font a code point is an octal code obtained from a
- character encoding scheme (WinAnsiEncoding, MacRomaonEncoding, etc).
- For example, the code point for the space character is 040 (octal).
- For a type 0 font a code point represents a GID (Glyph index).
-
- A character code point.
-
-
-
-
- Specifies the maximum distance characters in this font extend
- above the base line. This is the typographic ascent for the font.
-
-
-
-
- Specifies the maximum distance characters in this font extend
- below the base line. This is the typographic descent for the font.
-
-
-
-
- Gets the vertical coordinate of the top of flat captial letters.
-
-
-
-
- Gets the value of the first character used in the font
-
-
-
-
- Gets the value of the last character used in the font
-
-
-
-
- Gets a reference to a font descriptor. A descriptor is akin to
- the PDF FontDescriptor object (see page 355 of PDF 1.4 spec).
-
-
-
-
- Gets the widths of all characters in 1/1000ths of a point size.
-
-
-
-
- This is NOT the content width of the instream-foreign-object.
- This is the content width for a Box.
-
-
- This is NOT the content height of the instream-foreign-object.
- This is the content height for a Box.
-
-
- @param ul true if text should be underlined
-
-
- And eatable InlineSpace is discarded if it occurs
- as the first pending element in a LineArea
-
-
- adds text to line area
-
- @return int character position
-
-
- adds a Leader; actually the method receives the leader properties
- and creates a leader area or an inline area which is appended to
- the children of the containing line area.
- leader pattern use-content is not implemented.
-
-
- adds pending inline areas to the line area
- normally done, when the line area is filled and
- added as child to the parent block area
-
-
- aligns line area
-
-
-
- Balance (vertically) the inline areas within this line.
-
-
- sets hyphenation related traits: language, country, hyphenate, hyphenation-character
- and minimum number of character to remain one the previous line and to be on the
- next line.
-
-
- creates a leader as String out of the given char and the leader length
- and wraps it in an InlineArea which is returned
-
-
- calculates the width of space which has to be inserted before the
- start of the leader, so that all leader characters are aligned.
- is used if property leader-align is set. At the moment only the value
- for leader-align="reference-area" is supported.
-
-
-
- calculates the used space in this line area
-
-
- extracts a complete word from the character data
-
-
- Calculates the wordWidth using the actual fontstate
-
-
- adds a single character to the line area tree
-
-
- Same as addWord except that characters in wordBuf is mapped
- to the current fontstate's encoding
-
-
- adds a InlineArea containing the String startChar+wordBuf to the line area children.
-
-
- Checks if it's legal to break a word in the middle
- based on the current language property.
- @return true if legal to break word in the middle
-
-
- Helper method for getting the width of a unicode char
- from the current fontstate.
- This also performs some guessing on widths on various
- versions of space that might not exists in the font.
-
-
- Helper method to determine if the character is a
- space with normal behaviour. Normal behaviour means that
- it's not non-breaking
-
-
- Method to determine if the character is a nonbreaking
- space.
-
-
- @return true if the character represents any kind of space
-
-
- Add a word that might contain non-breaking spaces.
- Split the word into WordArea and InlineSpace and add it.
- If addToPending is true, add to pending areas.
-
-
- an object that stores a rectangle that is linked, and the LineArea
- that it is logically associated with
- @author Arved Sandstrom
- @author James Tauber
-
-
- the linked Rectangle
-
-
- the associated LineArea
-
-
- the associated InlineArea
-
-
- a set of rectangles on a page that are linked to a common
- destination
-
-
- the destination of the links
-
-
- the set of rectangles
-
-
- Store all hyphenation related properties on an FO.
- Public "structure" allows direct member access.
-
-
- Store all hyphenation related properties on an FO.
- Public "structure" allows direct member access.
-
-
- Ensure that page is set not only on B.A.C. but also on the
- three top-level reference areas.
- @param area The region-body area container (special)
-
-
- Store all hyphenation related properties on an FO.
- Public "structure" allows direct member access.
-
-
- This class holds information about text-decoration
-
-
-
- @return true if text should be underlined
-
-
- set text as underlined
-
-
- @return true if text should be overlined
-
-
-
- A collection of instances.
-
-
-
-
- Adds the supplied to the end of the collection.
-
-
-
-
-
- Returns an ArrayList enumerator that references a read-only version
- of the BfEntry list.
-
-
-
-
-
- Gets the at index.
-
-
-
-
- Gets the number of objects contained by this
-
-
-
-
-
- Returns the number of instances that
- represent bfrange's
-
-
-
-
-
-
-
-
-
-
- Returns the number of instances that
- represent bfchar's
-
-
-
-
-
-
-
-
-
-
- A class can represent either a bfrange
- or bfchar.
-
-
-
-
- Class cosntructor.
-
-
-
-
-
-
- Increments the end index by one.
-
-
- Incrementing the end index turns this BfEntry into a bfrange.
-
-
-
-
- Returns true if this BfEntry represents a glyph range, i.e.
- the start index is not equal to the end index.
-
-
-
-
- Returns true if this BfEntry represents a bfchar entry, i.e.
- the start index is equal to the end index.
-
-
-
-
- A File Identifier is described in section 8.3 of the PDF specification.
- The first string is a permanent identifier based on the contents of the file
- at the time it was originally created, and does not change as the file is
- incrementally updated. The second string is a changing identifier based
- on the file's contents the last time it was updated.
-
-
- If this class were being use to update a PDF's file identifier, we'd need
- to add a method to parse an existing file identifier.
-
-
-
-
- Initialises the CreatedPart and ModifiedPart to a randomly generated GUID.
-
-
-
-
- Initialises the CreatedPart and ModifiedPart to the passed string.
-
-
-
-
- Returns the CreatedPart as a byte array.
-
-
-
-
- Returns the ModifiedPart as a byte array.
-
-
-
-
- Thrown during creation of PDF font object if the font's license
- is violated, e.g. attempting to subset a font that does not permit
- subsetting.
-
-
-
-
- Represents an entry in the directory table
-
-
-
-
- Gets an instance of an implementation that is
- capable of parsing the table identified by tab.
-
-
-
-
-
- Returns the table tag as a string
-
-
-
-
-
- Gets the table tag encoded as an unsigned 32-bite integer.
-
-
-
-
- Gets or sets a value that represents a
- offset, i.e. the number of bytes from the beginning of the file.
-
-
-
-
- Gets or sets a value representing the number number of bytes
- a object occupies in a stream.
-
-
-
-
- Gets or sets value that represents a checksum of a .
-
-
-
-
- Class designed to parse a TrueType font file.
-
-
-
-
- A Big Endian stream.
-
-
-
-
- Used to identity a font within a TrueType collection.
-
-
-
-
- Maps a table name (4-character string) to a
-
-
-
-
- A dictionary of cached instances.
- The index is the table name.
-
-
-
-
- Maps a glyph index to a subset index.
-
-
-
-
- Class constructor.
-
- Font data stream.
-
-
-
- Class constructor.
-
- Font data stream.
- Name of a font in a TrueType collection.
-
-
-
- Gets a value indicating whether or not this font contains the
- supplied table.
-
- A table name.
-
-
-
-
- Gets a reference to the table structure identified by tableName
-
-
- Only the following tables are supported:
- - Font header,
- - Horizontal header,
- - Horizontal metrics,
- - Maximum profile,
- - Index to location,
- - Glyf data,
- - Control value,
- - Control value program,
- - Font program
-
- A 4-character code identifying a table.
-
- If tableName does not represent a table in this font.
-
-
-
-
- Gets a object for the supplied table.
-
- A 4-character code identifying a table.
-
- A object or null if the table cannot
- be located.
-
-
- If tag does not represent a table in this font.
-
-
-
-
- Reads the Offset and Directory tables. If the FontFileStream represents
- a TrueType collection, this method will look for the aforementioned
- tables belonging to fontName.
-
-
- This method can handle a TrueType collection.
-
-
-
-
- Caches the following tables: 'head', 'hhea', 'maxp', 'loca'
-
-
-
-
- Sets the stream position to the offset in the supplied directory
- entry. Also ensures that the FontFileStream has enough bytes
- available to read a font table. Throws an exception if this
- condition is not met.
-
-
-
- If the supplied stream does not contain enough data.
-
-
-
-
- Gets or sets a dictionary containing glyph index to subset
- index mappings.
-
-
-
-
- Gets the underlying .
-
-
-
-
- Gets the number tables.
-
-
-
-
- Class designed to read and write primitive datatypes from/to a
- TrueType font file.
-
-
-
All OpenType fonts use Motorola-style byte ordering (Big Endian).
-
The following table lists the primitives and their definition.
- Note the difference between the .NET CLR definition of certain
- types and the TrueType definition.
-
- BYTE 8-bit unsigned integer.
- CHAR 8-bit signed integer.
- USHORT 16-bit unsigned integer.
- SHORT 16-bit signed integer.
- ULONG 32-bit unsigned integer.
- LONG 32-bit signed integer.
- Fixed 32-bit signed fixed-point number (16.16)
- FWORD 16-bit signed integer (SHORT) that describes a
- quantity in FUnits.
- UFWORD 16-bit unsigned integer (USHORT) that describes a
- quantity in FUnits.
- F2DOT14 16-bit signed fixed number with the low 14 bits of
- fraction (2.14).
- LONGDATETIME Date represented in number of seconds since 12:00
- midnight, January 1, 1904. The value is represented
- as a signed 64-bit integer.
- Tag Array of four uint8s (length = 32 bits) used to identify
- a script, language system, feature, or baseline
- GlyphID Glyph index number, same as uint16(length = 16 bits)
- Offset Offset to a table, same as uint16 (length = 16 bits),
- NULL offset = 0x0000
-
-
-
-
-
- Initialises a new instance of the
- class using the supplied byte array as the underlying buffer.
-
- The font data encoded in a byte array.
-
- data is a null reference.
-
-
- data is a zero-length array.
-
-
-
-
- Initialises a new instance of the
- class using the supplied stream as the underlying buffer.
-
- Reference to an existing stream.
-
- stream is a null reference.
-
-
-
-
- Reads an unsigned byte from the font file.
-
-
-
-
-
- Writes an unsigned byte from the font file.
-
-
-
-
-
- Reads an signed byte from the font file.
-
-
-
-
-
- Writes a signed byte from the font file.
-
-
-
-
-
- Reads a short (16-bit signed integer) from the font file.
-
-
-
-
-
- Writes a short (16-bit signed integer) to the font file.
-
-
-
-
-
- Reads a short (16-bit signed integer) from the font file.
-
-
-
-
-
- Writes a short (16-bit signed integer) to the font file.
-
-
-
-
-
- Reads a int (16-bit unsigned integer) from the font file.
-
-
-
-
-
- Writes a int (16-bit unsigned integer) to the font file.
-
-
-
-
-
- Reads a int (16-bit unsigned integer) from the font file.
-
-
-
-
-
- Writes a int (16-bit unsigned integer) to the font file.
-
-
-
-
-
- Reads an int (32-bit signed integer) from the font file.
-
-
-
-
-
- Writes an int (32-bit signed integer) to the font file.
-
-
-
-
-
- Reads a int (32-bit unsigned integer) from the font file.
-
-
-
-
-
- Writes a int (32-bit unsigned integer) to the font file.
-
-
-
-
-
- Reads an int (32-bit signed integer) from the font file.
-
-
-
-
-
- Writes an int (32-bit unsigned integer) to the font file.
-
-
-
-
-
- Reads a long (64-bit signed integer) from the font file.
-
-
-
-
-
- Writes a long (64-bit signed integer) to the font file.
-
-
-
-
-
- Reads a tag (array of four bytes) from the font stream.
-
-
-
-
-
- Writes a tab (array of four bytes) to the font file.
-
-
-
-
-
- Ensures the stream is padded on a 4-byte boundary.
-
-
- This method will output between 0 and 3 bytes to the stream.
-
-
- A value between 0 and 3 (inclusive).
-
-
-
-
- Writes a sequence of bytes to the underlying stream.
-
-
-
-
-
-
-
- Reads a block of bytes from the current stream and writes
- the data to buffer.
-
- A byte buffer big enough to store count bytes.
- The byte offset in buffer to begin reading.
- Number of bytes to read.
-
-
-
- Offsets the stream position by the supplied number of bytes.
-
-
-
-
-
- Saves the current stream position onto a marker stack.
-
-
- Returns the current stream position.
-
-
-
-
- Sets the stream using the marker at the
- head of the marker stack.
-
-
- Returns the stream position before it was reset.
-
-
- If the markers stack is empty.
-
-
-
-
- Gets or sets the current position of the font stream.
-
-
-
-
- Gets the length of the font stream in bytes.
-
-
-
-
- A specialised stream writer for creating OpenType fonts.
-
-
-
-
- Size of the offset table in bytes.
-
-
-
-
- The underlying stream.
-
-
-
-
- List of font tables to write.
-
-
-
-
- Creates a new instance of the class
- using stream as the underlying stream object.
-
-
-
- If stream is not writable.
-
-
- If streamm is a null reference.
-
-
-
-
- Queues the supplied for writing
- to the underlying stream.
-
-
- The method will not immediately write the supplied font
- table to the underlying stream. Instead it queues the
- font table since the offset table must be written out
- before any tables.
-
-
-
-
-
- Writes the header and font tables to the underlying stream.
-
-
-
-
- Updates the checkSumAdjustment field in the head table.
-
-
-
-
- Writes out each table to the font stream.
-
-
-
-
- Writes the offset table that appears at the beginning of
- every TrueType/OpenType font.
-
-
-
-
- Does not actually write the table directory - simply "allocates"
- space for it in the stream.
-
-
-
-
- Returns the maximum power of 2 <= max
-
-
-
-
-
-
- Calculates the checksum of the entire font.
-
-
- The underlying must be aligned on
- a 4-byte boundary.
-
-
-
-
-
- Calculates the checksum of a .
-
-
- The supplied stream must be positioned at the beginning of
- the table.
-
-
-
-
-
-
- Gets the underlying .
-
-
-
-
- Generates a subset from a TrueType font.
-
-
-
-
- Creates a new instance of the FontSubset class.
-
- TrueType font parser.
-
-
-
- Writes the font subset to the supplied output stream.
-
-
-
-
- Reads a glyph description from the specified offset.
-
-
-
-
- Populate the compositesIList containing all child glyphs
- that this glyph uses.
-
-
- The stream parameter must be positioned 10 bytes from
- the beginning of the glyph description, i.e. the flags field.
-
-
-
-
- Gets the length of the glyph description in bytes at
- index index.
-
-
-
-
-
-
- Bit masks of the flags field in a composite glyph.
-
-
-
-
- Utility class that stores a list of glyph indices and their
- asociated subset indices.
-
-
-
-
- Maps a glyph index to a subset index.
-
-
-
-
- Maps a subset index to glyph index.
-
-
-
-
- Class constructor.
-
-
-
-
- Determines whether a mapping exists for the supplied glyph index.
-
-
-
-
-
-
- Returns the subset index for glyphIndex. If a subset
- index does not exist for glyphIndex one is generated.
-
-
- A subset index.
-
-
-
- Adds the list of supplied glyph indices to the index mappings using
- the next available subset index for each glyph index.
-
-
-
-
-
- Gets the subset index of glyphIndex.
-
-
-
- A glyph index or -1 if a glyph to subset mapping does not exist.
-
-
-
-
- Gets the glyph index of subsetIndex.
-
-
-
- A subset index or -1 if a subset to glyph mapping does not exist.
-
-
-
-
- Gets the number of glyph to subset index mappings.
-
-
-
-
- Gets a list of glyph indices sorted in ascending order.
-
-
-
-
- Gets a list of subset indices sorted in ascending order.
-
-
-
-
- Key - Kerning pair identifier
- Value - Kerning amount
-
-
-
-
- Creates an instance of KerningPairs allocating space for
- 100 kerning pairs.
-
-
-
-
- Creates an instance of KerningPairs allocating space for
- numPairs kerning pairs.
-
-
-
-
-
- Returns true if a kerning value exists for the supplied
- glyph index pair.
-
- Glyph index for left-hand glyph.
- Glyph index for right-hand glyph.
-
-
-
-
- Creates a new kerning pair.
-
-
- This method will ignore duplicates.
-
- The glyph index for the left-hand glyph in the kerning pair.
- The glyph index for the right-hand glyph in the kerning pair.
- The kerning value for the supplied pair.
-
-
-
- Returns a kerning pair identifier.
-
-
-
-
-
-
-
- Gets the kerning amount for the supplied glyph index pair.
-
-
-
-
- Gets the number of kernings pairs.
-
-
-
-
- A helper designed that provides the size of each TrueType primitives.
-
-
-
-
- List of all TrueType and OpenType tables
-
-
-
-
- Converts one of the predefined table names to an unsigned integer.
-
-
-
-
-
-
- Class that represents the Control Value Program table ('prep').
-
-
-
-
- Class derived by all TrueType table classes.
-
-
-
-
- The dictionary entry for this table.
-
-
-
-
- Class constructor
-
- The table name.
- Table directory entry.
-
-
-
- Reads the contents of a table from the current position in
- the supplied stream.
-
-
-
- If the supplied stream does not contain enough data.
-
-
-
-
- Writes the contents of a table to the supplied writer.
-
-
- This method should not be concerned with aligning the
- table output on the 4-byte boundary.
-
-
-
-
-
- Gets or sets a directory entry for this table.
-
-
-
-
- Gets the unique name of this table as a 4-character string.
-
-
- Note that some TrueType tables are only 3 characters long
- (e.g. 'cvt'). In this case the returned string will be padded
- with a extra space at the end of the string.
-
-
-
-
- Gets the table name encoded as a 32-bit unsigned integer.
-
-
-
-
- Set of instructions executed whenever point size or font
- or transformation change.
-
-
-
-
- Creates an instance of the class.
-
-
-
-
-
- Reads the contents of the "prep" table from the current position
- in the supplied stream.
-
-
-
-
-
- Writes out the array of instructions to the supplied stream.
-
-
-
-
-
- Class that represents the Control Value table ('cvt').
-
-
-
-
- List of N values referenceable by instructions.
-
-
-
-
- Creates an instance of the class.
-
-
-
-
-
- Reads the contents of the "cvt" table from the current position
- in the supplied stream.
-
-
-
-
-
- Writes out the array of values to the supplied stream.
-
-
-
-
-
- Gets the value representing the number of values that can
- be referenced by instructions.
-
-
-
-
- Class that represents the Font Program table ('fpgm').
-
-
-
-
- List of N instructions.
-
-
-
-
- Creates an instance of the class.
-
-
-
-
-
- Reads the contents of the "fpgm" table from the current position
- in the supplied stream.
-
-
-
-
-
- Writes out the array of instructions to the supplied stream.
-
-
-
-
-
- Gets the value representing the number of instructions
- in the font program.
-
-
-
-
- Instantiates a font table from a table tag.
-
-
-
-
- Prevent instantiation since this is a factory class.
-
-
-
-
- Creates an instance of a class that implements the FontTable interface.
-
-
- One of the pre-defined TrueType tables from the class.
-
-
-
- A subclass of that is capable of parsing
- a TrueType table.
-
-
- If a class capable of parsing tableName is not available.
-
-
-
-
- Class that represents the Glyf Data table ('glyf').
-
-
- http://www.microsoft.com/typography/otspec/glyf.htm
-
-
-
-
- Maps a glyph index to a object.
-
-
-
-
- Creates an instance of the class.
-
-
-
-
-
- Reads the contents of the "glyf" table from the current position
- in the supplied stream.
-
-
-
-
-
- Writes the contents of the glyf table to the supplied stream.
-
-
-
-
-
- Gets the instance located at glyphIndex
-
-
-
-
- Gets the number of glyphs.
-
-
-
-
- Represents either a simple or composite glyph description from
- the 'glyf' table.
-
-
- This class is nothing more than a wrapper around
- a byte array.
-
-
-
-
- The index of this glyph as obtained from the 'loca' table.
-
-
-
-
- Contains glyph description as raw data.
-
-
-
-
- List of composite glyph indices.
-
-
-
-
- Class constructor.
-
-
-
-
- Sets the glyph data (duh!).
-
-
-
-
-
- Add the supplied glyph index to list of children.
-
-
-
-
-
- Writes a glyph description to the supplied stream.
-
-
-
-
-
- Gets or sets the index of this glyph.
-
-
-
-
- Gets the length of the glyph data buffer.
-
-
-
-
- Gets a ilst of child glyph indices.
-
-
-
-
- Gets a value indicating whether or not this glyph represents
- a composite glyph.
-
-
-
-
- Class that represents the Font Header table.
-
-
- http://www.microsoft.com/typography/otspec/head.htm
-
-
-
-
- Class constructor.
-
-
-
-
-
- Reads the contents of the "head" table from the current position
- in the supplied stream.
-
-
-
-
-
- Returns a DateTime instance which is the result of adding seconds
- to BaseDate. If an exception occurs, BaseDate is returned.
-
-
-
-
-
- Writes the contents of the head table to the supplied stream.
-
-
-
-
-
- Gets a value that indicates whether glyph offsets in the
- loca table are stored as a int or ulong.
-
-
-
-
- Class that represents the Horizontal Header table.
-
-
- http://www.microsoft.com/typography/otspec/hhea.htm
-
-
-
-
- Table version number 0x00010000 for version 1.0.
-
-
-
-
- Typographic ascent. (Distance from baseline of highest ascender).
-
-
-
-
- Typographic descent. (Distance from baseline of lowest descender).
-
-
-
-
- Typographic line gap. Negative LineGap values are treated as zero
- in Windows 3.1, System 6, and System 7.
-
-
-
-
- Maximum advance width value in 'hmtx' table.
-
-
-
-
- Minimum left sidebearing value in 'hmtx' table.
-
-
-
-
- Minimum right sidebearing value.
-
-
-
-
- Max(lsb + (xMax - xMin)).
-
-
-
-
- Used to calculate the slope of the cursor (rise/run); 1 for vertical.
-
-
-
-
- 0 for vertical.
-
-
-
-
- The amount by which a slanted highlight on a glyph needs to be
- shifted to produce the best appearance. Set to 0 for non-slanted fonts.
-
-
-
-
- 0 for current format.
-
-
-
-
- Number of hMetric entries in 'hmtx' table.
-
-
-
-
- Class constructor.
-
-
-
-
-
- Reads the contents of the "hhea" table from the current position
- in the supplied stream.
-
-
-
-
-
- Gets the number of horiztonal metrics.
-
-
-
-
- Summary description for HorizontalMetric.
-
-
-
-
- Class that represents the Horizontal Metrics ('hmtx') table.
-
-
- http://www.microsoft.com/typography/otspec/hmtx.htm
-
-
-
-
- Initialises a new instance of the
- class.
-
-
-
-
-
- Initialises a new instance of the HorizontalMetricsTable class.
-
-
-
-
- Reads the contents of the "hmtx" table from the supplied stream
- at the current position.
-
-
-
-
-
- Returns the number of horizontal metrics stored in the
- hmtx table.
-
-
-
-
- Gets the located at index.
-
-
-
-
- Class that represents the Index To Location ('loca') table.
-
-
- http://www.microsoft.com/typography/otspec/loca.htm
-
-
-
-
- Initialises a new instance of the
- class.
-
-
-
-
-
- Initialises a new instance of the IndexToLocationTable class.
-
-
-
-
- Reads the contents of the "loca" table from the supplied stream
- at the current position.
-
-
-
-
-
- Removes all offsets.
-
-
-
-
- Includes the supplied offset.
-
-
-
-
-
- Gets the number of glyph offsets.
-
-
-
-
- Gets or sets the glyph offset at index index.
-
- A glyph index.
-
-
-
-
- Class that represents the Kerning table.
-
-
- http://www.microsoft.com/typography/otspec/kern.htm
-
-
-
-
- Class constructor.
-
-
-
-
-
- Reads the contents of the "kern" table from the current position
- in the supplied stream.
-
-
-
-
-
- No supported.
-
-
-
-
-
- Gets a boolean value that indicates this font contains format 0
- kerning information.
-
-
-
-
- Returns a collection of kerning pairs.
-
-
- If HasKerningInfo returns false, this method will
- always return null.
-
-
-
-
- Class that represents the Horizontal Metrics ('maxp') table.
-
-
- http://www.microsoft.com/typography/otspec/maxp.htm
-
-
-
-
- Table version number
-
-
-
-
- The number of glyphs in the font.
-
-
-
-
- Maximum points in a non-composite glyph.
-
-
-
-
- Maximum contours in a non-composite glyph. Only set if
- versionNo is 1.0.
-
-
-
-
- Maximum points in a composite glyph. Only set if
- versionNo is 1.0.
-
-
-
-
- Maximum contours in a composite glyph. Only set if
- versionNo is 1.0.
-
-
-
-
- 1 if instructions do not use the twilight zone (Z0), or
- 2 if instructions do use Z0; should be set to 2 in most
- cases. Only set if versionNo is 1.0.
-
-
-
-
- Maximum points used in Z0. Only set if
- versionNo is 1.0.
-
-
-
-
- Number of Storage Area locations. Only set if
- versionNo is 1.0.
-
-
-
-
- Number of FDEFs. Only set if versionNo is 1.0.
-
-
-
-
- Number of IDEFs. Only set if versionNo is 1.0.
-
-
-
-
- Maximum stack depth2. Only set if versionNo is 1.0.
-
-
-
-
- Maximum byte count for glyph instructions. Only set
- if versionNo is 1.0.
-
-
-
-
- Maximum number of components referenced at "top level"
- for any composite glyph. Only set if
- versionNo is 1.0.
-
-
-
-
- Maximum levels of recursion; 1 for simple components.
- Only set if versionNo is 1.0.
-
-
-
-
- Initialises a new instance of the
- class.
-
-
-
-
-
- Reads the contents of the "maxp" table from the supplied stream
- at the current position.
-
-
-
-
-
- Gets the number of glyphs
-
-
-
-
- Class that represents the Naming ('name') table
-
-
- http://www.microsoft.com/typography/otspec/name.htm
-
-
-
-
- Offset to start of string storage (from start of table).
-
-
-
-
- Reads the contents of the "name" table from the supplied stream
- at the current position.
-
-
-
-
-
- Reads a string from the storage area beginning at offset
- consisting of length bytes. The returned string will be
- converted using the Unicode encoding.
-
- Big-endian font stream.
-
- The offset in bytes from the beginning of the string storage area.
-
- The length of the string in bytes.
-
-
-
-
- Not supported.
-
-
-
-
-
- Get the font family name.
-
-
-
-
- Gets the font full name composed of the family name and the
- subfamily name.
-
-
-
-
- Class that represents the OS/2 ('OS/2') table
-
-
-
For detailed information on the OS/2 table, visit the following link:
- http://www.microsoft.com/typography/otspec/os2.htm
-
For more details on the Panose classification metrics, visit the following URL:
- http://www.panose.com/hardware/pan2.asp
-
-
-
-
- Reads the contents of the "os/2" table from the supplied stream
- at the current position.
-
-
-
-
-
- Gets a boolean value that indicates whether this font contains
- italic characters.
-
-
-
-
- Gets a boolean value that indicates whether characters are
- in the standard weight/style.
-
-
-
-
- Gets a boolean value that indicates whether characters possess
- a weight greater than or equal to 700.
-
-
-
-
- Gets a boolean value that indicates whether this font contains
- characters that all have the same width.
-
-
-
-
- Gets a boolean value that indicates whether this font contains
- special characters such as dingbats, icons, etc.
-
-
-
-
- Gets a boolean value that indicates whether characters
- do possess serifs
-
-
-
-
- Gets a boolean value that indicates whether characters
- are designed to simulate hand writing.
-
-
-
-
- Gets a boolean value that indicates whether characters
- do not possess serifs
-
-
-
-
- Gets a boolean value that indicates whether this font may be
- legally embedded.
-
-
-
-
- Gets a boolean value that indicates whether this font may be
- subsetted.
-
-
-
-
- Class that represents the PostScript ('post') table
-
-
- http://www.microsoft.com/typography/otspec/post.htm
-
-
-
-
- 0x00010000 for version 1.0
- 0x00020000 for version 2.0
- 0x00025000 for version 2.5 (deprecated)
- 0x00030000 for version 3.0
-
-
-
-
- Italic angle in counter-clockwise degrees from the vertical.
- Zero for upright text, negative for text that leans to the
- right (forward).
-
-
-
-
- This is the suggested distance of the top of the underline from
- the baseline (negative values indicate below baseline).
-
-
-
-
- Suggested values for the underline thickness.
-
-
-
-
- Set to 0 if the font is proportionally spaced, non-zero if the
- font is not proportionally spaced (i.e. monospaced).
-
-
-
-
- Minimum memory usage when an OpenType font is downloaded.
-
-
-
-
- Maximum memory usage when an OpenType font is downloaded.
-
-
-
-
- Minimum memory usage when an OpenType font is downloaded
- as a Type 1 font.
-
-
-
-
- Maximum memory usage when an OpenType font is downloaded
- as a Type 1 font.
-
-
-
-
- Class constructor.
-
-
-
-
-
- Reads the contents of the "post" table from the supplied stream
- at the current position.
-
-
-
-
-
- Gets a boolean value that indicates whether this font is
- proportionally spaced (fixed pitch) or not.
-
-
-
-
- Class that represents the Offset and Directory tables.
-
-
- http://www.microsoft.com/typography/otspec/otff.htm
-
-
-
-
- Gets a value indicating whether or not this font contains the
- supplied table.
-
- A table name.
-
-
-
-
- Gets a DirectoryEntry object for the supplied table.
-
- A 4-character code identifying a table.
-
- A DirectoryEntry object or null if the table cannot be located.
-
-
- If tableName does not represent a table in this font.
-
-
-
-
- Gets the number tables.
-
-
-
-
- A very lightweight wrapper around a Win32 device context
-
-
-
-
- Pointer to device context created by ::CreateDC()
-
-
-
-
- Creates a new device context that matches the desktop display surface
-
-
-
-
- Invokes .
-
-
-
-
- Delete the device context freeing the associated memory.
-
-
-
-
- Selects a font into a device context (DC). The new object
- replaces the previous object of the same type.
-
- Handle to object.
- A handle to the object being replaced.
-
-
-
- Gets a handle to an object of the specified type that has been
- selected into this device context.
-
-
-
-
- Returns a handle to the underlying device context
-
-
-
-
- A thin wrapper around a handle to a font
-
-
-
-
- Class constructor
-
- A handle to an existing font.
- The typeface name of a font.
- The height of a font.
-
-
-
- Class destructor
-
-
-
-
- Creates a font based on the supplied typeface name and size.
-
- The typeface name of a font.
-
- The height, in logical units, of the font's character
- cell or character.
-
-
-
-
-
-
-
-
-
- Creates a font whose height is equal to the negative value
- of the EM Square
-
-
-
-
-
- Retrieves all pertinent TrueType tables by invoking GetFontData.
-
-
-
-
- Summary description for GdiFontEnumerator.
-
-
-
-
- Class constructor.
-
- A non-null reference to a wrapper around a GDI device context.
-
-
-
- Returns a list of font styles associated with familyName.
-
-
-
-
-
-
- Returns a list of font family names sorted in ascending order.
-
-
-
-
- Class that obtains OutlineTextMetrics for a TrueType font
-
-
-
-
-
-
- Gets font metric data for a TrueType font or TrueType collection.
-
-
-
-
-
- Retrieves the widths, in PDF units, of consecutive glyphs.
-
-
- An array of integers whose size is equal to the number of glyphs
- specified in the 'maxp' table.
- The width at location 0 is the width of glyph with index 0,
- The width at location 1 is the width of glyph with index 1,
- etc...
-
-
-
-
- Returns the width, in PDF units, of consecutive glyphs for the
- WinAnsiEncoding only.
-
- An array consisting of 256 elements.
-
-
-
- Translates the supplied character to a glyph index using the
- currently selected font.
-
- A unicode character.
-
-
-
-
- Retrieves the typeface name of the font that is selected into the
- device context supplied to the GdiFontMetrics constructor.
-
-
-
-
- Specifies the number of logical units defining the x- or y-dimension
- of the em square for this font. The common value for EmSquare is 2048.
-
-
- The number of units in the x- and y-directions are always the same
- for an em square.)
-
-
-
-
- Gets the main italic angle of the font expressed in tenths of
- a degree counterclockwise from the vertical.
-
-
- Regular (roman) fonts have a value of zero. Italic fonts typically
- have a negative italic angle (that is, they lean to the right).
-
-
-
-
- Specifies the maximum distance characters in this font extend
- above the base line. This is the typographic ascent for the font.
-
-
-
-
- Specifies the maximum distance characters in this font extend
- below the base line. This is the typographic descent for the font.
-
-
-
-
- Gets the distance between the baseline and the approximate
- height of uppercase letters.
-
-
-
-
- Gets the distance between the baseline and the approximate
- height of non-ascending lowercase letters.
-
-
-
-
- TODO: The thickness, measured horizontally, of the dominant vertical
- stems of the glyphs in the font.
-
-
-
-
- Gets the value of the first character defined in the font
-
-
-
-
- Gets the value of the last character defined in the font
-
-
-
-
- Gets the average width of glyphs in a font.
-
-
-
-
- Gets the maximum width of glyphs in a font.
-
-
-
-
- Gets a value indicating whether the font can be legally embedded
- within a document.
-
-
-
-
- Gets a value indicating whether the font can be legally subsetted.
-
-
-
-
- Gets the font's bounding box.
-
-
- This is the smallest rectangle enclosing the shape that would
- result if all the glyphs of the font were placed with their
- origins cooincident and then filled.
-
-
-
-
- Gets a collection of flags defining various characteristics of
- a font (e.g. serif or sans-serif, symbolic, etc).
-
-
-
-
- Gets a collection of kerning pairs.
-
-
-
-
-
- Gets a collection of kerning pairs for characters defined in
- the WinAnsiEncoding scheme only.
-
-
-
-
-
- Class constructor.
-
- Kerning pairs read from the TrueType font file.
- Class to convert from TTF to PDF units.
-
-
-
- Returns true if a kerning value exists for the supplied
- character index pair.
-
-
-
-
-
-
-
- Gets the number of kerning pairs.
-
-
-
-
- Gets the kerning amount for the supplied index pair or 0 if
- a kerning pair does not exist.
-
-
-
-
- Installs a collection of private fonts on the system and uninstalls
- them when disposed.
-
-
-
-
- Specifies that only the process that called the AddFontResourceEx
- function can use this font.
-
-
-
-
- Specifies that no process, including the process that called the
- AddFontResourceEx function, can enumerate this font.
-
-
-
-
- Collection of absolute filenames.
-
-
-
-
- Adds filename to this private font collection.
-
-
- Absolute path to a TrueType font or collection.
-
-
- If filename is null.
- If filename is the empty string.
-
-
-
- Adds fontFile to this private font collection.
-
-
- Absolute path to a TrueType font or collection.
-
-
- If fontFile does not exist.
-
-
- If fontFile has already been added.
-
-
- If fontFile cannot be added to the system font collection.
-
-
-
-
- Custom collection that maintains a list of Unicode ranges
- a font supports and the glyph indices of each character.
- The list of ranges is obtained by invoking GetFontUnicodeRanges,
- however the associated glyph indices are lazily instantiated as
- required to save memory.
-
-
-
-
- List of unicode ranges in ascending numerical order. The order
- is important since a binary search is used to locate and
- uicode range from a charcater.
-
-
-
-
- Class constuctor.
-
-
-
-
-
- Loads all the unicode ranges.
-
-
-
-
- Locates the for the supplied character.
-
-
-
- The object housing c or null
- if a range does not exist for c.
-
-
-
-
- Translates the supplied character to a glyph index.
-
- Any unicode character.
-
- A glyph index for c or 0 the supplied character does
- not exist in the font selected into the device context.
-
-
-
-
- Gets the number of unicode ranges.
-
-
-
-
- Converts from logical TTF units to PDF units.
-
-
-
-
- Class constructor.
-
-
- Specifies the number of logical units defining the x- or
- y-dimension of the em square of a font.
-
-
-
-
- Convert the supplied integer from TrueType units to PDF units
- based on the EmSquare
-
-
-
- If the value of emSquare is zero, this method will
- always return value.
-
-
-
-
- The ABC structure contains the width of a character in a TrueType font.
-
-
-
-
- TODO: Figure out why CreateFontIndirect fails when this class
- is converted to a struct.
-
-
-
-
- The OUTLINETEXTMETRIC structure contains metrics describing
- a TrueType font.
-
-
-
-
- The PANOSE structure describes the PANOSE font-classification values
- for a TrueType font. These characteristics are then used to associate
- the font with other fonts of similar appearance but different names.
-
-
-
-
- The Point structure defines the x- and y- coordinates of a point.
-
-
-
-
- The Rect structure defines the coordinates of the upper-left
- and lower-right corners of a rectangle
-
-
-
-
- The TEXTMETRIC structure contains basic information about a physical
- font. All sizes are specified in logical units; that is, they depend
- on the current mapping mode of the display context.
-
-
-
-
- Class that represents a unicode character range as returned
- by the GetFontUnicodeRanges function.
-
-
-
-
- Array of glyph indices for each character represented by
- this range begining at .
-
-
-
-
- Class constructor.
-
- GDI Device content
- Value representing start of unicode range.
- Value representing end of unicode range.
-
-
-
- Returns the glyph index of c.
-
-
-
-
-
-
- Populates the indices array with the glyph index of each
- character represented by this rnage starting at .
-
-
-
-
- Gets a value representing the start of the unicode range.
-
-
-
-
- Gets a value representing the end of the unicode range.
-
-
-
-
- Summary description for UnicodeRangeComparer.
-
-
-
-
- Maps a Unicode character to a WinAnsi codepoint value.
-
-
-
-
- First column is codepoint value. Second column is unicode value.
-
-
-
-
- The root of a document's object hierarchy is the catalog dictionary.
-
-
- The document catalog is described in section 3.6.1 of the PDF specification.
-
-
-
-
- A dictionary that contains information about a CIDFont program.
-
-
- A Type 0 CIDFont contains glyph descriptions based on Adobe's Type
- 1 font format, whereas those in a Type 2 CIDFont are based on the
- TrueType font format.
-
-
-
-
- A dictionary containing entries that define the character collection
- of the CIDFont.
-
-
-
-
- Class that defines a mapping between character codes (CIDs)
- to a character selector (Identity-H encoding)
-
-
-
-
- TODO: This method is temporary. I'm assuming that all string should
- be represented as a PdfString object?
-
-
-
-
-
- Adds the supplied glyph -> unicode pairs.
-
-
- Both the key and value must be a int.
-
-
-
-
-
- Adds the supplied glyph index to unicode value mapping.
-
-
-
-
-
-
- Overriden to create CMap content stream.
-
-
-
-
-
- Writes the bfchar entries to the content stream in groups of 100.
-
-
-
-
-
- Writes the bfrange entries to the content stream in groups of 100.
-
-
-
-
-
- Was originally called PdfDocument, but this name is now in
- use by the Telerik.Pdf library. Eventually all code in this
- class should either be moved to either the Telerik.Pdf library,
- or to the PdfRenderer.
-
-
-
- Get the root Outlines object. This method does not write
- the outline to the Pdf document, it simply creates a
- reference for later.
-
-
- Make an outline object and add it to the given outline
- @param parent parent PdfOutline object
- @param label the title for the new outline object
- @param action the PdfAction to reference
-
-
- get the /Resources object for the document
-
- @return the /Resources object
-
-
-
- PDF defines a standard date format. The PDF date format closely
- follows the format defined by the international standard ASN.1.
-
-
- The format of the PDF date is defined in section 3.8.2 of the
- PDF specification.
-
-
-
-
- A class that enables a well structured PDF document to be generated.
-
-
- Responsible for allocating object identifiers.
-
-
-
-
- Class representing a file trailer.
-
-
- File trailers are described in section 3.4.4 of the PDF specification.
-
-
-
-
- Returns the internal name used for this font.
-
-
-
-
- Creates all the necessary PDF objects required to represent
- a font object in a PDF document.
-
-
-
-
- Generates object id's.
-
-
-
-
-
-
-
-
-
-
- Returns a subclass of the PdfFont class that may be one of
- PdfType0Font, PdfType1Font or PdfTrueTypeFont. The type of
- subclass returned is determined by the type of the font
- parameter.
-
- The PDF font identifier, e.g. F15
- Underlying font object.
-
-
-
-
- Creates a character indexed font from cidFont
-
-
- The font and cidFont will be different object
- references since the font parameter will most likely
- be a .
-
- The Pdf font identifier, e.g. F15
- Required to access the font descriptor.
- The underlying CID font.
-
-
-
-
- Returns the next available Pdf object identifier.
-
-
-
-
-
- Creates an instance of the class
-
- The Pdf font identifier, e.g. F15
-
-
-
-
-
- Creates an instance of the class
- that defaults the font encoding to WinAnsiEncoding.
-
-
-
-
-
-
-
-
- A ProxyFont must first be resolved before getting the
- IFontMetircs implementation of the underlying font.
-
-
-
-
-
- An enumeration listing all the fonts types available in Pdf.
-
-
-
-
- An enumeration listing all the font subtypes
-
-
-
-
- An International Color Code stream
-
-
-
-
- Represents a Identity-H character encoding
-
-
- Maps 2-byte character codes ranging from 0 to 65,535 to
- the same 2-byte CID value, interpreted high-order byte first
-
-
-
-
- Do not call this method directly
-
-
-
-
- Do not call this method directly
-
-
-
-
- Class representing a document information dictionary.
-
-
- Document information dictionaries are described in section 9.2.1 of the
- PDF specification.
-
-
-
-
- Well-known PDF name objects.
-
-
-
-
- This represents a single Outline object in a PDF, including the root Outlines
- object. Outlines provide the bookmark bar, usually rendered to the right of
- a PDF document in user agents such as Acrobat Reader
-
-
-
-
- List of sub-entries (outline objects)
-
-
-
-
- Parent outline object. Root Outlines parent is null
-
-
-
-
- Title to display for the bookmark entry
-
-
-
-
- Class constructor.
-
- The object id number
- The title of the outline entry (can only be null for root Outlines obj)
- The page which this outline refers to.
-
-
-
- Add a sub element to this outline
-
-
-
-
-
- The pages of a document are accessed through a structure known
- as the page tree.
-
-
- The page tree is described in section 3.6.2 of the PDF specification.
-
-
-
-
- Returns this PdfString expressed using the 'literal' convention.
-
-
- A literal string is written as an arbitrary number of characters
- enclosed in parentheses. Any characters may appear in a string
- except unbalanced parentheses and the backslash, which must be
- treated specially. Balanced pairs of parentheses within a string
- require no special treatment.
-
-
-
-
- Used by ToPdfHexadecimal.
-
-
-
-
- Returns the PdfString expressed using the 'hexadecimal' convention.
-
-
- Strings may also be written in hexadecimal form; this is useful for
- including arbitrary binary data in a PDF file. A hexadecimal string
- is written as a sequence of hexadecimal digits (0–9 and either A–F
- or a–f) enclosed within angle brackets (< and >).
-
-
-
-
- The convention used when outputing the string to the PDF document.
-
-
- Defaults to format.
-
-
-
-
- Determines if the string should bypass encryption, even when
- available.
-
-
- Some PDF strings need to appear unencrypted in a secure PDF
- document. Most noteably those in the encryption dictionary
- itself. This property allows those strings to be flagged.
-
-
-
-
- The PDF specification describes two conventions that can be
- used to embed a string in a PDF document. This enumeration,
- along with the property
- can be used to select how a string will be formatted in the
- PDF file.
-
-
-
-
- A unique object number.
-
-
- The name by which the font is reference in the Font subdictionary
-
-
- The PostScript name of the font.
-
-
-
-
- Sets a value representing the character encoding.
-
-
-
-
- Sets the font descriptor.
-
-
-
-
- Sets the first character code defined in the font's widths array
-
-
- The default value is 0.
-
-
-
-
- Sets the last character code defined in the font's widths array
-
-
- The default value is 255.
-
-
-
-
- Sets the array of character widths.
-
-
-
-
- A Type 0 font is a composite font whose glyphs are obtained from a
- font like object called a CIDFont (a descendant font).
-
-
- All versions of the PDF specification up to and including version 1.4
- only support a single descendant font.
-
-
-
-
- Sets the stream containing a CMap that maps character codes to
- unicode values.
-
-
-
-
- Sets the descendant font.
-
-
-
-
- Sets a value representing the character encoding.
-
-
-
-
- Sets a value representing the character encoding.
-
-
-
-
- Array class used to represent the /W entry in the CIDFont dictionary.
-
-
-
-
- ARC4 is a fast, simple stream encryption algorithm that is
- compatible with RSA Security's RC4 algorithm.
-
-
-
-
- Initialises internal state from the passed key.
-
-
- Can be called again with a new key to reuse an Arc4 instance.
-
- The encryption key.
-
-
-
- Encrypts or decrypts the passed byte array.
-
-
- The data to be encrypted or decrypted.
-
-
- The location that the encrypted or decrypted data is to be placed.
- The passed array should be at least the same size as dataIn.
- It is permissible for the same array to be passed for both dataIn
- and dataOut.
-
-
-
-
- Generates a pseudorandom byte used to encrypt or decrypt.
-
-
-
-
- Implements Adobe's standard security handler. A security handler is
- a software module that implements various aspects of the encryption
- process.
-
-
-
-
- Constructs a new standard security manager.
-
-
- The user supplied PDF options that provides access to the passwords and
- the access permissions.
-
-
- The PDF document's file identifier (see section 8.3 of PDF specification).
-
-
-
-
- Computes the master key that is used to encrypt string and stream data
- in the PDF document.
-
-
- The user supplied PDF options that provides access to the passwords and
- the access permissions.
-
-
- The PDF document's file identifier (see section 8.3 of PDF specification).
-
-
-
-
- Computes the O(owner) value in the encryption dictionary.
-
-
- Corresponds to algorithm 3.3 on page 69 of the PDF specficiation.
-
-
- The user supplied PDF options that provides access to the passwords.
-
-
-
-
- Computes the U(user) value in the encryption dictionary.
-
-
- Corresponds to algorithm 3.4 on page 70 of the PDF specficiation.
-
-
- The user supplied PDF options that provides access to the passwords.
-
-
-
-
- Encrypts the passed byte array using the ARC4 cipher.
-
-
-
-
- Computes an encryption key that is used to encrypt string and stream data
- in the PDF document.
-
-
- Corresponds to algorithm 3.1 in section 3.5 of the PDF specficiation.
-
-
-
-
- Computes an encryption key that is used to encrypt string and stream data
- in the PDF document.
-
-
- Corresponds to algorithm 3.2 in section 3.5 of the PDF specficiation.
-
-
-
-
- Pads or truncates a password string to exactly 32-bytes.
-
-
- Corresponds to step 1 of algorithm 3.2 on page 69 of the PDF 1.3 specficiation.
-
- The password to pad or truncate.
-
- A byte array of length 32 bytes containing the padded or truncated password.
-
-
-
-
- Determines if the passed password matches the user password
- used to initialise this security manager.
-
-
- Used for testing purposes only. Corresponds to algorithm 3.5 in the
- PDF 1.3 specification.
-
- True if the password is correct.
-
-
-
- Performs the actual checking of the user password.
-
-
-
-
- Checks the owner password.
-
-
-
-
- Compares two byte arrays and returns true if they are equal.
-
-
-
-
- Access to the raw user entry byte array.
-
-
- Required for testing purposes;
-
-
-
-
- Access to the raw owner entry byte array.
-
-
- Required for testing purposes;
-
-
-
-
- Password that disables all security permissions
-
-
-
-
- The user password
-
-
-
-
- Collection of flags describing permissions granted to user who opens
- a file with the user password.
-
-
- The given initial value zero's out first two bits.
- The PDF specification dictates that these entries must be 0.
-
-
-
-
- Enables or disables printing.
-
- If true enables printing otherwise false
-
-
-
- Enable or disable changing the document other than by adding or
- changing text notes and AcroForm fields.
-
-
-
-
-
- Enable or disable copying of text and graphics from the document.
-
-
-
-
-
- Enable or disable adding and changing text notes and AcroForm fields.
-
-
-
-
-
- Returns the owner password as a string.
-
-
- The default value is null
-
-
-
-
- Returns the user password as a string.
-
-
- The default value is null
-
-
-
-
- The document access privileges encoded in a 32-bit unsigned integer
-
-
- The default access priviliges are:
-
-
Printing disallowed
-
Modifications disallowed
-
Copy and Paste disallowed
-
Addition or modification of annotation/form fields disallowed
-
- To override any of these priviliges see the ,
- , ,
- methods
-
-
-
-
- A single section in a PDF file's cross-reference table.
-
-
- The cross-reference table is described in section 3.4.3 of
- the PDF specification.
-
-
-
-
- Right now we only support a single subsection.
-
-
-
-
- Adds an entry to the section.
-
-
-
-
- Writes the cross reference section to the passed PDF writer.
-
-
-
-
- A sub-section in a PDF file's cross-reference table.
-
-
- The cross-reference table is described in section 3.4.3 of
- the PDF specification.
-
-
-
-
- This entries contained in this subsection.
-
-
-
-
- Creates a new blank sub-section, that initially contains no entries.
-
-
-
-
- Adds an entry to the sub-section.
-
-
-
-
- Writes the cross reference sub-section to the passed PDF writer.
-
-
-
-
- Structure representing a single cross-reference entry.
-
-
-
-
- The object number and generation number.
-
-
-
-
- The number of bytes from the beginning of the file to
- the beginning of the object.
-
-
-
-
- Implementation of IComparable.
-
-
-
-
- A PDF file's cross-reference table.
-
-
- The cross-reference table is described in section 3.4.3 of
- the PDF specification.
-
-
-
-
- Right now we only support a single section.
-
-
-
-
- Adds an entry to the table.
-
-
-
-
- Writes the cross reference table to the passed PDF writer.
-
-
-
-
- A marker interface to indicate an object can be passed to
- the property.
-
-
-
-
-
-
-
- Sets up the PDF fonts.
-
-
- Assigns the font (with metrics) to internal names like "F1" and
- assigns family-style-weight triplets to the fonts.
-
-
-
-
- First 16 indices are used by base 14 and generic fonts
-
-
-
-
- Handles mapping font triplets to a IFontMetric implementor
-
-
-
-
- Adds all the system fonts to the FontInfo object.
-
-
- Adds metrics for basic fonts and useful family-style-weight
- triplets for lookup.
-
- Determines what type of font to instantiate.
-
-
-
- Returns true is familyName represents one of the
- base 14 fonts; otherwise false.
-
-
-
-
-
-
- Gets the next available font name. A font name is defined as an
- integer prefixed by the letter 'F'.
-
-
-
-
-
- Add the fonts in the font info to the PDF document.
-
- Object that creates PdfFont objects.
- Resources object to add fonts too.
-
-
-
- Base class for the standard 14 fonts as defined in the PDF spec.
-
-
-
-
- Base class for PDF font classes
-
-
-
-
- Maps a Unicode character to a character index.
-
- A Unicode character.
-
-
-
-
- See
-
-
-
-
- Get the encoding of the font.
-
-
- A font encoding defines a mapping between a character code
- and a code point.
-
-
-
-
- Gets the base font name.
-
-
-
-
-
- Gets the type of font, e.g. Type 0, Type 1, etc.
-
-
-
-
-
- Gets the font subtype.
-
-
-
-
-
- Gets a reference to a FontDescriptor
-
-
-
-
- Gets a boolean value indicating whether this font supports
- multi-byte characters
-
-
-
-
- See
-
-
-
-
- See
-
-
-
-
- See
-
-
-
-
- See
-
-
-
-
- See
-
-
-
-
- See
-
-
-
-
- Class constructor.
-
-
-
-
- Will always return null since the standard 14 fonts do not
- have a FontDescriptor.
-
-
- It is possible to override the default metrics, but the
- current version of Apoc does not support this feature.
-
-
-
-
- Base class for a CID (Character Indexed) font.
-
-
- There are two types of CIDFont: Type 0 and Type 2. A Type 0 CIDFont
- contains glyph description based on Adobe Type 1 font format; a
- Type 2 CIDFont contains glyph descriptions based on the TrueType
- font format.
- See page 338 of the Adode PDF 1.4 specification for futher details.
-
-
-
-
- Gets the PostScript name of the font.
-
-
-
-
- Gets a dictionary mapping character codes to unicode values
-
-
-
-
- Returns .
-
-
-
-
- Gets a string identifying the issuer of the character collections.
-
-
- The default implementation returns .
-
-
-
-
- Gets a string that uniquely names the character collection.
-
-
- The default implementation returns .
-
-
-
-
- Gets the supplement number of the character collection.
-
-
- The default implementation returns .
-
-
-
-
- Gets the default width for all glyphs.
-
-
- The default implementation returns
-
-
-
-
- Represents a collection of font descriptor flags specifying
- various characterisitics of a font.
-
-
- The following lists the bit positions and associated flags:
- 1 - FixedPitch
- 2 - Serif
- 3 - Symbolic
- 4 - Script
- 6 - Nonsymbolic
- 7 - Italic
- 17 - AllCap
- 18 - SmallCap
- 19 - ForceBold
-
-
-
-
- Default class constructor.
-
-
-
-
- Class constructor. Initialises the flags BitVector with the
- supplied integer.
-
-
-
-
- Gets the font descriptor flags as a 32-bit signed integer.
-
-
-
-
- Handy enumeration used to reference individual bit positions
- in the BitVector32.
-
-
-
-
- Collection of font properties such as face name and whether the
- a font is bold and/or italic.
-
-
-
-
- Class constructor.
-
-
- Regular : bold=false, italic=false
- Bold : bold=true, italic=false
- Italic : bold=false, italic=true
- BoldItalic : bold=true, italic=true
-
- Font face name, e.g. Arial.
- Bold flag.
- Italic flag.
-
-
-
- A proxy object that delegates all operations to a concrete
- subclass of the Font class.
-
-
-
-
- Flag that indicates whether the underlying font has been loaded.
-
-
-
-
- Font details such as face name, bold and italic flags
-
-
-
-
- The font that does all the work.
-
-
-
-
- Determines what type of "real" font to instantiate.
-
-
-
-
- Class constructor.
-
-
-
-
-
-
- Loads the underlying font.
-
-
-
-
- Gets the underlying font.
-
-
-
-
- Represents a TrueType font program.
-
-
-
-
- Wrapper around a Win32 HDC.
-
-
-
-
- Provides font metrics using the Win32 Api.
-
-
-
-
- List of kerning pairs.
-
-
-
-
- Maps a glyph index to a PDF width
-
-
-
-
-
-
-
-
-
- Class constructor
-
-
-
-
-
- Creates a object from baseFontName
-
-
-
-
- See
-
- A WinAnsi codepoint.
-
-
-
-
- Returns .
-
-
-
-
- A Type 2 CIDFont is a font whose glyph descriptions are based on the
- TrueType font format.
-
-
- TODO: Support font subsetting
-
-
-
-
- Wrapper around a Win32 HDC.
-
-
-
-
- Provides font metrics using the Win32 Api.
-
-
-
-
- List of kerning pairs.
-
-
-
-
- Maps a glyph index to a PDF width
-
-
-
-
- Windows font name, e.g. 'Arial Bold'
-
-
-
-
-
-
-
-
-
- Maps a glyph index to a character code.
-
-
-
-
- Maps character code to glyph index. The array is based on the
- value of .
-
-
-
-
- Class constructor.
-
-
-
-
-
- Creates a object from baseFontName
-
-
-
-
- Class destructor.
-
-
-
-
- Returns .
-
-
-
-
- A subclass of Type2CIDFont that generates a subset of a
- TrueType font.
-
-
-
-
- Maps a glyph index to a subset index.
-
-
-
-
- Quasi-unique six character name prefix.
-
-
-
-
- Class constructor.
-
-
-
-
-
- Creates the index mappings list and adds the .notedef glyphs
-
-
-
-
- Enumeration that dictates how Apoc should treat fonts when
- producing a PDF document.
-
-
-
Each of the three alernatives has particular advantages and
- disadvantages, which will be explained here.
-
The member specifies that all fonts
- should be linked. This option will produce the smallest PDF
- document because the font program required to render individual
- glyphs is not embedded in the PDF document. However, this
- option does possess two distinct disadvantages:
-
-
Only characters in the WinAnsi character encoding are
- supported (i.e. Latin)
-
The PDF document will not render correctly if the linked
- font is not installed.
- ///
-
The option will copy the contents of
- the entire font program into the PDF document. This will guarantee
- correct rendering of the document on any system, however certain
- fonts - especially CJK fonts - are extremely large. The MS Gothic
- TrueType collection, for example, is 8MB. Embedding this font file
- would produce a ridicuously large PDF.
-
Finally, the option will only copy the required
- glyphs required to render a PDF document. This option will ensure that
- a PDF document is rendered correctly on any system, but does incur a
- slight processing overhead to subset the font.
-
-
-
-
-
- Retrieves all the colors from the Standard preset.
-
-
- A ColorPickerItemCollection collection with the colors from the Standard preset.
-
-
-
- Dim colors As ColorPickerItemCollection = RadColorPicker1.GetStandardColors()
-
-
- ColorPickerItemCollection colors = RadColorPicker1.GetStandardColors();
-
-
-
-
-
- Restores view-state information from a previous request that was saved with the System.Web.UI.WebControls.WebControl.SaveViewState() method.
-
- An object that represents the control state to restore.
-
-
-
- Saves any state that was modified after the System.Web.UI.WebControls.Style.TrackViewState() method was invoked.
-
- An object that contains the current view state of the control; otherwise, if there is no view state associated with the control, null.
-
-
-
- Causes the control to track changes to its view state so they can be stored in the object's System.Web.UI.Control.ViewState property.
-
-
-
-
- Collection of the color picker items
-
-
-
-
- Get/Set the preset colors of the color picker
-
-
-
-
- Get/Set the selected color of the ColorPicker
-
-
-
-
- Get/Set the number of the columns in the palette
-
-
-
-
- True to cause a postback on value change.
-
-
-
-
- True to show the None color selection
-
-
-
-
- True to show the color picker as an icon, which when clicked opens the palette
-
-
-
-
- True to preview the color which has been selected
-
-
-
-
- Gets or sets the localization strings for the color picker
-
-
-
-
- Gets or sets the tooltip of the icon
-
-
-
-
- Gets or sets the text in the icon
-
-
-
-
- Gets or sets the text for the no color box
-
-
-
-
- Gets or sets a value indicating the behavior of this object - if can be resized, has expand/collapse commands, closed command, etc.
-
-
-
- Gets or sets a value indicating whether the colorpicker will create an overlay element.
- The default value is false.
-
-
- Gets or sets a value indicating whether the ColorPicker popup will stay in the visible viewport of the browser window.
- The default value is true.
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadColorPicker control is initialized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadColorPicker object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientLoad property.
-
-
- <script type="text/javascript">
- function OnClientLoad(sender, args)
- {
- var ColorPicker = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when a user previews a color.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadColorPicker that fired the event.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientColorPreview property.
-
-
- <script type="text/javascript">
- function OnClientColorPreview(sender, args)
- {
- var ColorPicker = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- while the value of the color picker has been changed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientColorChange
- client-side event handler that is called
- when the value of the color picker has been changed. Two parameters are passed to the handler:
-
- sender, the RadColorPicker object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientColorChange property.
-
-
- <script type="text/javascript">
- function OnColorChangeHandler(sender, args)
- {
- var ColorPicker = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when the popup element of the RadColorPicker (in case ShowIcon=true) shows.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientPopUpShow
- client-side event handler is called when the value of the color picker has been changed.
- Two parameters are passed to the handler:
-
- sender, the RadColorPicker object.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientPopUpShow property.
-
-
- <script type="text/javascript">
- function OnClientPopUpShow(sender, args)
- {
- var ColorPicker = sender;
- }
- </script>
-
-
-
-
-
-
- Represents the animation settings like type and duration for the control.
-
-
-
-
- Represents the animation settings like type and duration.
-
-
-
-
-
-
-
- Gets or sets the effect that will be used for the animation.
-
- On of the AnimationType values. The default value
- is OutQuart.
-
-
- Use the Type property of the AnimationSettings
- class to customize the effect used for the animation. To turn off animation effects set
- this property to None.
-
-
-
- Gets or sets the duration in milliseconds of the animation.
- An integer representing the duration in milliseconds of the animation.
-
-
- Gets or sets the duration in milliseconds of the animation.
-
- An integer representing the duration in milliseconds of the animation.
- The default value is 450 milliseconds.
-
-
-
-
- The Telerik.Web.UI.RadComboBoxFilter enumeration supports three values - None, Contains, StartsWith. Default is None.
-
-
-
-
- The Telerik.Web.UI.RadComboBoxSort enumeration supports three values - None, Ascending, Descending. Default is None.
-
-
-
-
- Items are not sorted at all.
-
-
-
-
- Items are sorted in ascending order (min to max)
-
-
-
-
- Items are sorted in descending order (max to min)
-
-
-
-
- Data class used for transferring control items (menu items, tree nodes, etc.)
- from and to web services.
-
-
-
-
-
-
-
-
- Text for the item to pass to the client.
-
-
-
-
- Value for the item to pass to the client.
-
-
-
-
- A value indicating if the item to pass to the client is enabled.
-
-
-
-
- Custom attributes for the item to pass to the client.
-
-
-
-
- Gets all script URLs that should be registered by a script manager for the given control
-
- A control reference to get scripts from
- Whether to check child controls as well
- A list of script URLs
-
-
-
- This control is used to render a on a dummy page so we can get the actual control scripts when RegisterWithScriptManager is false
-
-
-
-
- Gets value indicating if the HTTP compression is activated
-
-
-
-
- Retrieves 's configuration section from the webconfig
-
-
-
-
-
- Gets value indicating if the compression filter should be applied on full page postbacks
-
-
-
-
-
- Gets value indicating if the ViewState compression is activated
-
-
-
-
- Indicates if compression type should be explicitly added to content encoding header
-
-
-
-
-
- Represents request handler name
-
-
-
-
- Indicates if handler's name represents only portion of request handler
- URL. Default value is true
-
-
-
-
- If return true ViewState data will be compressed even the
- HTTPCompression is applied.Default is false.
-
-
-
-
- creates a new instance of the LayoutBuilder class
-
-
-
-
- Sets the RowCollection collection using the XML in the TableHtmlXml
-
-
-
-
- Returns a XmlDocument object based on the LayoutBuilderRow collection.
-
-
-
-
- Returns a Html Table version of current Layout.
-
-
-
-
- Saves the
-
-
-
-
- Saves the
-
-
-
-
- Loads the client state data
-
-
-
-
-
- Saves the client state data
-
-
-
-
- Gets or sets the xml file.
-
-
-
-
- Gets or sets the width of the Layout.
-
-
-
-
- Gets or sets the height of the Layout.
-
-
-
-
- Gets or sets the value indicating whether every cell should has id.
-
-
-
-
- Gets or sets the current table html source.
-
-
-
-
- Gets a XmlDocument in which is loaded the TableHtml.
-
-
-
-
-
-
-
-
- Copied from Reflector
-
-
-
-
-
-
-
-
-
-
-
-
- Gets the custom attributes which will be serialized on the client.
-
-
-
-
- Used internally.
-
-
-
-
- Represents an client-side operation (e.g. adding an item, removing an item, updating an item etc.)
-
- The type of the item (e.g. , ,
- , , , )
-
-
-
-
- Returns the item (, ,
- , , , )
- associated with this client operation.
-
-
- When the of the operation is the Item property will
- return null (Nothing in VB.NET) in case the items of the control have been cleared.
-
-
-
-
- Gets the type of the client operation
-
-
- One of the enumeration values.
-
-
- If the Type property is equal to the type will be used.
-
-
-
-
- Represents a script reference - including tracking its loaded state in the client browser
-
-
-
-
- Request param name for the serialized combined scripts string
-
-
-
-
- Request param name for the hidden field name
-
-
-
-
- Containing Assembly
-
-
-
-
- Script name
-
-
-
-
- Culture to render the script in
-
-
-
-
- Reference to the Assembly object (if loaded by LoadAssembly)
-
-
-
-
- Constructor
-
- containing assembly
- script name
- culture for rendering the script
-
-
-
- Constructor
-
- script reference
-
-
-
- Gets the script corresponding to the object
-
- script text
-
-
-
- Loads the associated Assembly
-
- Assembly reference
-
-
-
- Equals override to compare two ScriptEntry objects
-
- comparison object
- true iff both ScriptEntries represent the same script
-
-
-
- GetHashCode override corresponding to the Equals override above
-
- hash code for the object
-
-
-
- Deserialize a list of ScriptEntries
-
-
- Serialized list looks like:
- ;Assembly1.dll Version=1:Culture:MVID1:ScriptName1Hash:ScriptName2Hash;Assembly2.dll Version=2:Culture:MVID1:ScriptName3Hash
-
- serialized list
- list of scripts
-
-
-
- This enumeration lists the available controls in the file explorer and allows customizing the look of the control.
-
-
-
-
- A treeview, which shows the folders in the file explorer.
-
-
-
-
- A grid, which shows the files/folders in the current file explorer folder
-
-
-
-
- A toolbar, which provides shortcuts for the file explorer commands (delete, new folder, back, forward, etc.)
-
-
-
-
- A textbox, which shows the current selected path in the file explorer
-
-
-
-
- The grid and treeview context menus, which are shown when the user right clicks inside the controls.
-
-
-
-
- The default value for the RadFileExplorer control - all controls are shown
-
-
-
-
- This enumeration lists the possible FileExplorer control operation modes.
-
-
-
-
- The Default mode renders all controls in the FileExplorer (tree, grid, toolbar, etc.)
-
-
-
-
- The FileTree mode renders both files and folders in the tree and removes the grid control.
-
-
-
-
- Telerik File Explorer control
-
-
-
-
- Fired when on all file explorer file and folder operations.
-
- an instance of the RadFileExplorerEventArgs event argument.
-
-
-
- Fired when the grid data is retrieved from the content provider.
-
- an instance of the RadFileExplorerEventArgs event argument.
-
-
-
- Updates the strings that are localizable in the FileExplorer controls. Useful if you change the Localization collection after it has already
- set the values to the controls.
-
-
-
-
- Implemented using ASP.NET 2.0 Callback functionality built into RadTreeView
-
- the tree instance
- event arguments
-
-
-
- Handle Renaming of folders
-
- tree instance
- rename event arguments
-
-
-
- Rebinds the tree in the RadFileExplorer control. If there were any nodes in the tree when this method is called,
- they will be cleared unless you set the RadFileExplorer.Tree.AppendDataBoundItems property to true.
-
-
-
-
- This method is used in the RadTreeView1_NodeExpand handler, in the TreeUpdatePanel_AjaxRequest method, when a folder is created
- and in the TreeUpdatePanel_AjaxRequest method, in order to reach a node in the tree
-
- The node to be populated
-
-
-
- This method is used in OnNodeEdit handler
-
- the virtual path of the new node
- source node
- destination node
- true for a copy operation
-
-
-
- This method is used in OnNodeEdit handler and in RenameGridItem method to handle renaming the folder
- and node in tree
-
- the virtual path of the new node
- node to rename
- new name
-
-
-
- Create folder when perform this action in tree or in grid
-
- parent folder path
- new folder name
-
-
-
- delete folder/file(s) from the grid or tree
-
- a list of virtual paths to the item being deleted
-
-
-
- Get the Grid data for the current selected folder in the file explorer tree
-
- path to current selected folder
- sort argument (column and direction)
- the index of the first item to return (used for paging)
- the number of items to return (used for paging)
- if set to true, will return files and folders, otherwise only folders
- the control that needs the data ("grid" or "tree")
- out parameter - set to the number of items returned
- a list of files and folders in the selected path
-
-
-
- Restores view-state information from a previous request that was saved with the System.Web.UI.WebControls.WebControl.SaveViewState() method.
-
- An object that represents the control state to restore.
-
-
-
- Saves any state that was modified after the System.Web.UI.WebControls.Style.TrackViewState() method was invoked.
-
- An object that contains the current view state of the control; otherwise, if there is no view state associated with the control, null.
-
-
-
- Causes the control to track changes to its view state so they can be stored in the object's System.Web.UI.Control.ViewState property.
-
-
-
-
- Gets or sets the current FileExplorerMode (e.g. default, show files in the tree, etc.)
-
-
-
-
- When set to true, this property will enable paging in the File Explorer's Grid component.
-
-
-
-
- Gets or sets a value indicating whether to allow copying of files/folders
-
-
-
-
- Gets or sets a value indicating whether to allow creating new folders
-
-
-
-
- Gets or sets a value indicating whether to allow opening a new window with the file
-
-
-
-
- Gets or sets the width of the Web server control.
-
-
- A System.Web.UI.WebControls.Unit that represents the width of the control.
- The default is System.Web.UI.WebControls.Unit.Empty.
-
- The width of the Web server control was set to a negative value.
-
-
-
- Gets or sets the width of the file explorer's tree pane
-
-
- A System.Web.UI.WebControls.Unit that represents the width of the control.
- The default is 222 pixels.
-
- The width of the Web server control was set to a negative value.
-
-
-
- Gets or sets the height of the Web server control.
-
-
- A System.Web.UI.WebControls.Unit that represents the height of the control.
- The default is System.Web.UI.WebControls.Unit.Empty.
-
- The height of the Web server control was set to a negative value.
-
-
-
- Gets a reference to the toolbar, which shows on the top of the file explorer control.
-
-
-
-
- Gets a reference to the grid, which shows on the right of the file explorer control.
-
-
-
-
- Gets a reference to the tree, which shows on the left of the file explorer control.
-
-
-
-
- Gets a reference to the context menu, which shows when the user right-clicks the grid control
-
-
-
-
- Gets a reference to the upload component, which shows inside a popup window when the user wants to upload files.
- If you want to set the allowed file types or max upload file size, please use the Configuration property
-
-
-
-
- Gets a reference to the window component, which shows the upload popup and the alert/confirmation dialogs.
-
-
-
-
- Gets a reference to the splitter component in the file explorer
-
-
-
-
- Specifies an access key to enable keyboard navigation for the File Explorer control
-
-
-
-
- Gets or sets a string containing the localization language for the File Explorer UI
-
-
-
-
- Gets or sets a value indicating where the control will look for its .resx localization files.
- By default these files should be in the App_GlobalResources folder. However, if you cannot put
- the resource files in the default location or .resx files compilation is disabled for some reason
- (e.g. in a DotNetNuke environment), this property should be set to the location of the resource files.
-
-
- A relative path to the dialogs location. For example: "~/controls/RadEditorResources/".
-
-
- If specified, the LocalizationPath
- property will allow you to load the control localization files from any location in the
- web application.
-
-
-
-
- Specifies the skin that will be used by the control
-
-
-
-
- Contains the FileExplorer configuration (paths, content provider type, etc.).
-
-
- An FileManagerDialogConfiguration
- instance, containing the configuration of the control
-
-
-
-
- Gets or sets the initial path that will be shown in the file explorer control.
-
-
- If this property is not set, the file explorer will use the first path in the ViewPaths as the initial one.
-
-
-
-
- Gets or sets a value indicating whether to show the up one folder (..) item in the grid if available.
-
-
-
-
- Returns the currently selected node in the tree. This property is useful during postbacks.
-
-
-
-
- The name of the javascript function called when the user selects an item in the explorer.
-
-
-
-
- The name of the javascript function called when a folder is loaded in the grid.
-
-
-
-
- The name of the javascript function called when an item is double clicked in the grid.
-
-
-
-
- The name of the javascript function called when the the selected folder in the tree changes.
-
-
-
-
- The name of the javascript function called before the control loads in the browser.
-
-
-
-
- The name of the javascript function called when the control loads in the browser.
-
-
-
-
- The name of the javascript function called when the user tries to create a new folder.
-
-
-
-
- The name of the javascript function called when the user tries to delete a file.
-
-
-
-
- The name of the javascript function called when the user tries to rename/move a file or folder.
-
-
-
-
- The name of the javascript function called when the user tries to copy a file or folder.
-
-
-
-
- This event is fired when on all file and folder operations of the file explorer. If you wish to cancel the command
- simply return False from your event handler.
-
-
-
-
- This event is fired when the grid data is retrieved from the content provider
-
-
-
-
-
-
-
-
- Gets the virtual path for the current item command
-
-
-
-
- Gets the second virtual path for the current item command (for rename, move, etc. commands)
-
-
-
-
- Gets the virtual command name
-
-
-
-
- Set this argument to true if you wish to cancel the file explorer command
-
-
-
-
- Represents a EditorDropDown tool that renders as a custom dropdown in the editor
-
-
-
-
- Represents a EditorDropDown tool that renders as a custom dropdown in the editor
-
-
-
-
- This will set the width of the dropdown if it was set before.
-
- Unit containing the new default width
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets the collection of EditorTool objects, inside the tool strip.
-
- The tools.
-
-
-
- Telerik RadFormDecorator
-
-
-
-
- Form Decorator will render as a Div tag in order to be XHTML compliant
-
-
-
-
- Get/Set the DecoratedControls enum of RadFormDecorator
-
-
-
-
- Get/Set the ControlsToSkip enum of RadFormDecorator - a shortcut for faster fine-tuning of the decorated controls
-
-
-
-
- Gets or sets whether decorated textboxes, textarea and fieldset elements will have rounded corners
-
-
-
-
- Gets or sets the id (ClientID if a runat=server is used) of a html element whose children will be decorated
-
-
-
-
- A string, specifying the ID of the datasource control, which will be used to
- retrieve binary data of the attachment.
-
-
- A string, specifying the ID of the datasource control,
- which will be used to retrieve binary data of the attachment.
-
-
-
-
- Gets or sets a value indicating the type of the download button that will be rendered. The
- type should be one of the specified by the
- enumeration.
-
-
-
-
- LinkButton
- Renders a standard hyperlink button.
-
- PushButton
- Renders a standard button.
-
- ImageButton
- Renders an image that acts like a
- button.
-
-
-
-
- Gets or sets the CssClass of the button
-
-
-
-
- Gets or sets a string, representing a comma-separated enumeration of DataFields
- from the data source, that uniquely identify an attachment from the column's data source
-
-
- A string, representing a comma-separated enumeration of
- DataFields from the data source, which will form the url of the windwow/frame that the
- hyperlink will target.
-
-
-
-
- Gets or sets the name of the data field from the column's data source where the binary attachment data is stored.
-
-
-
-
- Use the DataTextField property to specify the field name
- from the data source to bind to the
- Text property of the
- buttons in the
- GridAttachmentColumn object.
- Binding the column to a field instead of directly setting the Text
- property allows you to display different captions for the buttons in the
- GridAttachmentColumn by using
- the values in the specified field.
- Tip: This property is most
- often used in combination with
-
- DataTextFormatString Property.
-
-
- Gets or sets a value from the specified datasource field. This value will then be
- displayed in the GridAttachmentColumn.
-
-
-
-
-
-
-
-
-
-
-
-
- [ASPX/ASCX]<br/><br/><radg:RadGrid id=<font class="string">"RadGrid1"</font> runat=<font class="string">"server"</font>><br/> <MasterTableView AutoGenerateColumns=<font class="string">"False"</font>><br/> <Columns><br/> <radg:GridAttachmentColumn HeaderText=<font class="string">"Customer ID"</font><font color="red">DataTextField=<font class="string">"CustomerID"</font></font><br/><font color="red">DataTextFormatString=<font class="string">"Edit Customer {0}"</font></font> ButtonType=<font class="string">"LinkButton"</font> UniqueName=<font class="string">"ButtonColumn"</font>><br/> </radg:GridAttachmentColumn>
-
-
-
-
-
-
-
-
-
- Use the DataTextFormatString property to provide a custom
- display format for the caption of the buttons in the
- GridAttachmentColumn.
- Note: The entire
- string must be enclosed in braces to indicate that it is a format string and not a
- literal string. Any text outside the braces is displayed as literal text.
-
-
-
-
-
-
-
-
-
-
- [ASPX/ASCX]<br/><br/><radg:RadGrid id=<font color="black"><font class="string">"RadGrid1"</font> runat=<font class="string">"server"</font>><br/> <MasterTableView AutoGenerateColumns=<font class="string">"False"</font>><br/> <Columns><br/> <radg:GridAttachmentColumn HeaderText=<font class="string">"Customer ID"</font></font><font color="red">DataTextField=<font class="string">"CustomerID"</font><br/>DataTextFormatString=<font class="string">"Edit Customer {0}"</font></font> ButtonType=<font class="string" color="black">"LinkButton"</font> UniqueName=<font color="black"><font class="string">"ButtonColumn"</font>><br/> </radg:GridAttachmentColumn></font>
-
-
-
- Gets or sets the string that specifies the display format for the caption in each
- button.
-
-
-
- Gets or sets a value indicating the text that will be shown for a button.
-
-
-
- Gets or sets the name of the field bound to the file name of the attachment.
-
-
-
-
- Gets or sets the format string applied to the value bound to the FileNameTextField property
-
-
-
-
- Gets or sets the file name of the attachment.
-
-
-
-
- Gets or sets a value indicating the URL for the image that will be used in a
- Image button. should be set to
- ImageButton.
-
-
-
-
- Gets or sets whether the column data can be filtered. The default value is
- true.
-
-
- A Boolean value, indicating whether the column can be
- filtered.
-
-
-
-
- Gets or sets the field name from the specified data source to bind to the
- .
-
-
- A string, specifying the data field from the data
- source, from which to bind the column.
-
-
-
-
- Gets or sets a string, specifying the text which will be shown as alternate
- text to the image
-
-
-
-
- Gets or sets the width of the image
-
-
-
-
- Gets or sets the height of the image
-
-
-
-
- Gets or sets a string, representing the DataField name from the data source,
- which will be used to supply the alternateText for the image in the column. This text can
- further be customized, by using the DataTextFormatString property.
-
-
- A string, representing the DataField name from the data
- source, which will be used to supply the alternate text for the image in the column.
-
-
-
-
- Gets or sets a string, specifying the format string, which will be used to format
- the alternate text of the image, rendered in the cells of the column.
-
-
- A string, specifying the format string, which will be
- used to format the text of the hyperlink, rendered in the cells of the column.
-
-
-
-
- Gets or sets whether the column data can be filtered. The default value is
- true.
-
-
- A Boolean value, indicating whether the column can be
- filtered.
-
-
-
- Gets or sets a whether the column data can be sorted.
-
- A boolean value, indicating whether the column data can
- be sorted.
-
-
-
-
- Gets or sets a string, representing a comma-separated enumeration of DataFields
- from the data source, which will form the url of the image which will be shown.
-
-
- A string, representing a comma-separated enumeration
- of DataFields from the data source, which will form the url of the image which
- will be shown.
-
-
-
-
- Gets or sets a string, specifying the FormatString of the DataNavigateURL.
- Essentially, the DataNavigateUrlFormatString property sets the formatting for the url
- string of the image.
-
-
- A string, specifying the FormatString of the
- DataNavigateURL.
-
-
-
-
- Gets or sets a string, specifying the url, from which the image should be
- retrieved. This property will be honored only if the DataImageUrlFields are
- not set. If either DataImageUrlFields are set, they will override the
- ImageUrl property.
-
-
- A string, specifying the url, from which the image,
- should be loaded.
-
-
-
- Gets or sets a whether the column data can be sorted.
-
- A boolean value, indicating whether the column data can
- be sorted.
-
-
-
-
- Gets or sets a string, specifying the text which will be shown as alternate
- text to the image
-
-
-
-
- Gets or sets the width of the image
-
-
-
-
- Gets or sets the height of the image
-
-
-
-
- Gets or sets a string, representing the DataField name from the data source,
- which will be used to supply the alternateText for the image in the column. This text can
- further be customized, by using the DataTextFormatString property.
-
-
- A string, representing the DataField name from the data
- source, which will be used to supply the alternate text for the image in the column.
-
-
-
-
- Gets or sets a string, specifying the format string, which will be used to format
- the alternate text of the image, rendered in the cells of the column.
-
-
- A string, specifying the format string, which will be
- used to format the text of the hyperlink, rendered in the cells of the column.
-
-
-
-
- Gets or sets whether the column data can be filtered. The default value is
- true.
-
-
- A Boolean value, indicating whether the column can be
- filtered.
-
-
-
-
- Provides properties related to setting the client-side data-binding in
- Telerik RadGrid.
-
-
- You can get a reference to this class using
- property.
-
-
-
-
- Gets a reference to class providing properties
- related to client-side ADO.NET DataService data-binding.
-
-
-
-
- Gets or sets url for the WebService or Page which will be requested to get data.
-
-
-
-
- Gets or sets method name in the WebService or Page which will be requested to get data.
-
-
-
-
- Gets or sets method name in the WebService or Page which will be requested to get total records count.
-
-
-
-
- Gets or sets maximum rows parameter name for the SelectMethod in the WebService or Page which will be requested to get data.
-
-
-
-
- Gets or set start row index parameter name for the SelectMethod in the WebService or Page which will be requested to get data.
-
-
-
-
- Gets or set sort parameter name for the SelectMethod in the WebService or Page which will be requested to get data.
-
-
-
-
- Gets or set filter parameter name for the SelectMethod in the WebService or Page which will be requested to get data.
-
-
-
-
- Gets or set filter parameter type for the SelectMethod in the WebService or Page which will be requested to get data. Default value is List.
-
-
-
-
- Gets or set sort parameter type for the SelectMethod in the WebService or Page which will be requested to get data. Default value is List.
-
-
-
-
- Gets or set a value indicating whether the client-side caching should be enabled or not.
-
-
-
-
- Gets or set data property name for the SelectMethod in the WebService or Page which will be requested to get data and count. Default is "Data"!
-
-
-
-
- Gets or set data property total records count for the SelectMethod in the WebService or Page which will be requested to get data and count. Default is "Count"!
-
-
-
-
- Gets or set table name for the specified ADO.NET DataService. Default is empty string!
-
-
-
-
- This property set whether active row should be set to first/last item when current item is last/first
- and down/up key is pressed (default is false)
-
-
-
-
- This property sets the key that is used to focus RadGrid. It is always used with CTRL key combination.
-
-
-
-
- This property sets the key that is used to open insert edit form of RadGrid. It is always used with CTRL key combination.
-
-
-
-
- This property sets the key that is used to rebind RadGrid. It is always used with CTRL key combination.
-
-
-
-
- Gets a collection of TargetInput objects that allows for
- specifying the objects for which input will be created on the client-side.
-
-
- Use the TargetControls collection to programmatically control
- which objects should be inputtipified on the client-side.
-
-
-
-
- Gets or sets an instance of the InputManagerClientEvents class
- which defines the JavaScript functions (client-side event handlers) that are invoked
- when specific client-side events are raised.
-
-
-
-
- Gets an instance of the InputSettingValidation class
- which defines the validation behavior.
-
-
-
- Gets or sets the css style for enabled TextBox control.
-
- A string object that represents the css style properties for enabled TextBox
- control. The default value is an empty string.
-
-
-
- Gets or sets a value to access the client-side behavior.
-
- In cases where you would like to access the client-side behavior for
- your setting from script code in the client, you can set this BehaviorID to simplify
- the process. See example below:
-
-
-
- Gets or sets the css style for hovered TextBox control.
-
- A string object that represents the css style properties for hovered TextBox
- control. The default value is an empty string object.
-
-
-
- Gets or stes the css style for invalid state of TextBox control.
-
- A string object that represents the style properties for invalid TextBox control.
- The default value is an empty string object.
-
-
-
- Gets or sets the css style for invalid state of TextBox control.
-
- A string object that represents the css style for invalid TextBox control. The
- default value is an empty string object.
-
-
-
- Gets or sets the css style for Read Only state of TextBox control.
-
- A string object that represents the css style for Read Only TextBox control. The
- default value is an empty string object.
-
-
-
- Gets or sets the css style for TextBox when when the control is disabled.
-
- A string object that represents the css style for TextBox control. The default
- value is an empty string object.
-
-
-
- Gets or sets the css style for TextBox when when the control is empty.
-
- A string object that represents the css style for TextBox control. The default
- value is an empty string object.
-
-
-
- Gets or sets a value message shown when the control is empty.
-
- A string specifying the empty message. The default value is empty string.
- ("").
-
-
- Shown when the control is empty and loses focus. You can set the empty message
- text through EmptyMessage property.
-
-
-
-
- Gets or sets the culture used by RadDateSetting to format the
- date.
-
-
- A
- CultureInfo object that represents the current culture used. The default value is
- System.Threading.Thread.CurrentThread.CurrentUICulture.
-
-
-
-
-
-
-
-
- Gets or sets the smallest date value allowed by
- RadDateSetting.
-
-
- A
- DateTime object that represents the smallest date value by
- RadDateSetting. The default value is 1/1/1980.
-
-
-
-
- Gets or sets the largest date value allowed by
- RadDateSetting.
-
-
- A
- DateTime object that represents the largest date value allowed by
- RadDateSetting. The default value is 12/31/2099.
-
-
-
-
- Gets or sets the date and time format used by
- RadDateSetting.
-
-
- A string specifying the date format used by RadDateSetting. The
- default value is "d" (short date format).
-
-
-
-
- Gets or sets the display date format used by
- RadDateSetting.(Visible when the control is not on focus.)
-
-
- A string specifying the display date format used by
- RadDateSetting. The default value is "d" (short date format). If the
- DisplayDateFormat is left blank, the DateFormat will
- be used both for editing and display.
-
-
-
-
- Gets or sets a value that indicates the end of the century that is used to
- interpret the year value when a short year (single-digit or two-digit year) is entered
- in the input.
-
- The year when the century ends. Default is 2029.
-
-
-
-
-
-
-
- Registers the control with the ScriptManager
-
-
-
-
- Registers the CSS references
-
-
-
-
- Loads the client state data
-
-
-
-
-
- Saves the client state data
-
-
-
-
-
- Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
-
-
-
- If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.
-
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
-
- For internal use.
-
-
-
-
- Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
-
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
-
- Gets the real skin name for the control user interface. If Skin is not set, returns
- "Default", otherwise returns Skin.
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
-
- The CssClass property will now be used instead of the former Skin
- and will be modified in AddAttributesToRender()
-
-
- protected override string CssClassFormatString
- {
- get
- {
- return "RadDock RadDock_{0} rdWTitle rdWFooter";
- }
- }
-
-
-
-
- Finds TargetInput setting by ID of input control
-
- ID of input control
- TargetInput or null
-
-
-
- Gets or sets url for the WebService or Page which will be requested to validate data.
-
-
-
-
- Gets or sets method name in the WebService or Page which will be requested to validate data.
-
-
-
-
- Gets a collection of InputSetting objects that allows for specifying the objects
- for which input elements will be created on the client-side.
-
-
-
- Gets or sets a value indicating whether manager should be enabled or not.
-
-
- Gets or sets the string to use as the decimal separator in values.
- The string to use as the decimal separator in values.
- The property is being set to an empty string.
- The property is being set to null.
-
-
- Gets or sets the number of decimal places to use in numeric values
- The number of decimal places to use in values.
- The property is being set to a value that is less than 0 or greater than 99.
-
-
-
- Gets or sets the number of digits in each group to the left of the decimal in
- values.
-
- The number of digits in each group to the left of the decimal in values.
- The property is being set to null.
-
-
-
- Gets or sets the string that separates groups of digits to the left of the
- decimal in values.
-
-
- The string that separates groups of digits to the left of the decimal in
- values.
-
- The property is being set to null.
-
-
- Gets or sets the format pattern for negative values.
- The format pattern for negative percent values.
- The property is being set to a value that is less than 0 or greater than 11.
-
-
- Gets or sets the format pattern for positive values.
- The format pattern for positive percent values. The
- The property is being set to a value that is less than 0 or greater than 3.
-
-
-
- Gets or sets the culture used by NumericTextBoxSetting to format
- the numburs.
-
-
- A CultureInfo object that represents the current culture used.
- The default value is System.Threading.Thread.CurrentThread.CurrentUICulture.
-
-
-
-
- Gets or sets the largest possible value of a
- NumericTextBoxSetting.
-
- The default value is positive 2^46.
-
-
-
- Specifies the position of the buttons in a .
-
-
-
-
- The buttons appear to the right of the listbox
-
-
-
-
- The buttons appear below the listbox
-
-
-
-
- The buttons appear to the left of the listbox
-
-
-
-
- The buttons appear above the listbox
-
-
-
-
- For internal use
-
-
-
-
-
-
- Specifies the horizontal alignment of buttons
-
-
-
-
- Buttons are left aligned
-
-
-
-
- Buttons are centered
-
-
-
-
- Buttons are right aligned
-
-
-
-
- This enumeration controls the Selection Mode of RadListBox.
-
-
-
-
- The default behaviour - only one Item can be selected at a time.
-
-
-
-
- Allows selection of multiple Items.
-
-
-
-
- Specifies the transfer behavior
-
-
-
-
- Items are moved to the destination listbox
-
-
-
-
- Items are copied to the destination listbox
-
-
-
-
- Specifies the vertical alignment of buttons
-
-
-
-
- The buttons are aligned with the top of the listbox
-
-
-
-
- The buttons are aligned with the middle of the listbox
-
-
-
-
- The buttons are aligned with the bottom of the listbox
-
-
-
-
- The Telerik.Web.UI.RadListBoxSort enumeration supports three values - None, Ascending, Descending. Default is None.
-
-
-
-
- Items are not sorted at all.
-
-
-
-
- Items are sorted in ascending order (min to max)
-
-
-
-
- Items are sorted in descending order (max to min)
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Provides data for the and events of the control.
-
-
-
-
- Gets the ID of the HTML element on which the source item(s) is(are) dropped.
-
-
- A string representing the ID of the HTML element on which the source item(s) is(are) dropped.
-
-
-
-
- Represents the method that handles the event
- of the control.
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Gets or sets a value indicating whether the event is canceled.
-
- true if cancel; otherwise, false.
-
- If the event is canceled the Dropped event will not fire.
-
-
-
-
- Represents the method that handles the event
- of the control.
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Gets or sets the source listbox of the transfer operation.
-
- The source listbox.
-
-
-
- Gets or sets the destination listbox of the transfer operation.
-
- The destination listbox.
-
-
-
- Gets or sets the referenced items in the control when the event is raised.
-
- The items.
-
-
-
- Represents the method that handles the event of the control.
-
-
-
-
- Provides data for the event.
-
-
-
-
- Provides data for the , ,
- and events.
-
-
-
-
- Initializes a new instance of the class.
-
- The referenced items the control when the event is raised.
-
-
-
- Gets the referenced items in the control when the event is raised.
-
- The referenced items in the control when the event is raised.
-
-
-
- Gets or sets a value indicating whether the event is canceled.
-
- true if cancel; otherwise, false.
-
- If the event is canceled the items will not be deleted.
-
-
-
-
- Represents the method that handles the event
- of the control.
-
-
-
-
- Represents the method that handles the event
- of the control.
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Gets or sets a value indicating whether the event is canceled.
-
- true if cancel; otherwise, false.
-
- If the is canceled the item will not be inserted.
-
-
-
-
- Represents the method that handles the event of the control.
-
-
-
-
- Provides data for the , events of the
- control.
-
-
-
-
- Initializes a new instance of the class.
-
- The referenced item.
-
-
-
- Gets or sets the referenced item in the control when the event is raised.
-
- The referenced item in the control when the event is raised.
-
-
-
- Represents the method that handles the and events.
- of the control.
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Gets or sets the referenced items in the control when the event is raised.
-
- The items.
-
-
-
- Gets or sets a value indicating whether the event is canceled.
-
- true if cancel; otherwise, false.
-
- If the event is canceled the item will not be reordered.
-
-
-
-
- Gets or sets the offset at which the item is reordered.
-
- The offset.
-
-
-
- Represents the method that handles the event of the control.
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Gets or sets the source listbox of the transfer operation.
-
- The source listbox.
-
-
-
- Gets or sets the destination listbox of the transfer operation.
-
- The destination listbox.
-
-
-
- Gets or sets a value indicating whether the event is canceled.
-
- true if cancel; otherwise, false.
-
- If the is canceled the item will not be transferred.
-
-
-
-
- Gets or sets the referenced items in the control when the event is raised.
-
- The items.
-
-
-
- Represents the method that handles the event of the control.
-
-
-
-
- Provides data for the event.
-
-
-
-
- Gets or sets a value indicating whether the event is canceled.
-
- true if cancel; otherwise, false.
-
- If the event is canceled the items will not be deleted.
-
-
-
-
- Represents the method that handles the event
- of the control.
-
-
-
-
- Represents the settings of the buttons in a controls.
-
-
-
-
- Gets or sets the width of the button area.
-
- The width of the area. The default value is 30px.
-
- The AreaWidth property is taken into consideration only if the property is set to or
- . If not the button area is as wide as the listbox control.
-
-
-
-
- Gets or sets the height of the button area.
-
- The height of the area. The default value is 30px
-
- The AreaWidth property is taken into consideration only if the property is set to or
- . If not the button area is as tall as the listbox control.
-
-
-
-
- Gets or sets the position of the buttons.
-
-
- The position of the buttons. The default value is .
-
-
-
-
- When set to true enables render text on buttons functionality
-
-
-
-
- Gets or sets the horizontal align of the buttons within the button area.
-
-
- The horizontal align. The default value is
-
-
- The HorizontalAlign property is taken into consideration only if the property is set to or
- .
-
-
-
-
- Gets or sets the vertical align of the buttons in the within the button area.
-
-
- The vertical align. The default value is
-
-
- The VerticalAlign property is taken into consideration only if the property is set to or
- .
-
-
-
-
- Gets or sets a value indicating whether to display the "delete" button.
-
- true if the "delete" button should be displayed; otherwise, false.
-
- RadListBox displays the "delete" button when the and
- properties are both set to true.
-
-
-
-
- Gets or sets a value indicating whether to display the "reorder" buttons.
-
- true if the "reorder" buttons should be displayed; otherwise, false.
-
- RadListBox displays the "reorder" buttons when the and
- properties are both set to true.
-
-
-
-
- Gets or sets a value indicating whether to display the "transfer" buttons.
-
- true if the "transfer" buttons should be displayed; otherwise, false.
-
- RadListBox displays the "transfer" buttons when the and
- properties are both set to true.
-
-
-
-
- Gets or sets a value indicating whether to display the "transfer all" buttons.
-
- true if the "transfer all" buttons should be displayed; otherwise, false.
-
- RadListBox displays the "transfer all" buttons when the and
- properties are both set to true.
-
-
-
-
- For internal use
-
-
-
-
-
-
- RadListBox is a flexible listbox control with the some unique features:
-
-
- Rich and highly customizable UI for item transfer, delete and reordering.
-
-
- Drag and drop support. Items can be reordered or transferred via drag and drop.
-
-
- Automatic update of the underlying data source during reorder, transfer or delete.
-
-
- Checkbox support
-
-
- All features supported by the built-in ListBox control.
-
-
-
-
-
-
- Loads the posted content of the list control, if it is different from the last posting.
-
- The key identifier for the control, used to index the postCollection.
- A that contains value information indexed by control identifiers.
- true if the posted content is different from the last posting; otherwise, false.
-
-
-
- Invokes the method whenever posted data for the RadListBox control has changed.
-
-
-
-
- Sets the property of a after a page is posted back.
-
- The index of the Item to select in the collection.
-
-
-
- Populates the control from an XML file
-
- Name of the XML file.
-
-
-
- Deletes the specified item. Fires the and events.
-
- The item which should be deleted.
-
- The Delete method updates the underlying datasource if the is set to true.
-
-
-
-
- Deletes the specified list of items. Fires the and events.
-
- The list of items which should be deleted.
-
- The Delete method updates the underlying datasource if the is set to true.
-
-
- This example demonstrates how to programmatically delete the selected items.
-
- RadListBox1.Delete(RadListBox1.SelectedItems);
-
-
- RadListBox1.Delete(RadListBox1.SelectedItems)
-
-
-
-
-
- Transfers the specified list of items from the source to the destination listbox. Fires the and events.
-
- The items to transfer.
- The source list box.
- The destination list box.
-
- Always call the Transfer method of the RadListBox whose property is set!
- The Transfer method updates the underlying datasource if the is set to true.
-
-
-
- RadListBox1.TransferToID = "RadListBox2";
- //Transfers all items of RadListBox1 to RadListBox2
- RadListBox1.Transfer(RadListBox1.Items, RadListBox1, RadListBox2);
- //Transfers all items of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
- RadListBox1.Transfer(RadListBox2.Items, RadListBox2, RadListBox1);
-
-
- RadListBox1.TransferToID = "RadListBox2"
- 'Transfers all items of RadListBox1 to RadListBox2
- RadListBox1.Transfer(RadListBox1.Items, RadListBox1, RadListBox2)
- 'Transfers all items of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
- RadListBox1.Transfer(RadListBox2.Items, RadListBox2, RadListBox1);
-
-
-
-
-
- Transfers the specified item from the source list box to the destination listbox.
- Fires the and events.
-
- The item to transfer.
- The source list box.
- The destination list box.
-
- Always call the Transfer method of the RadListBox whose property is set!
- The Transfer method updates the underlying datasource if the is set to true.
-
-
- The following example demonstrates how to use the Transfer method
-
- RadListBox1.TransferToID = "RadListBox2";
- //Transfers the first item of RadListBox1 to RadListBox2
- RadListBox1.Transfer(RadListBox1.Items[0], RadListBox1, RadListBox2);
- //Transfers the first item of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
- RadListBox1.Transfer(RadListBox2.Items[0], RadListBox2, RadListBox1);
-
-
- RadListBox1.TransferToID = "RadListBox2"
- 'Transfers the first item of RadListBox1 to RadListBox2
- RadListBox1.Transfer(RadListBox1.Items(0), RadListBox1, RadListBox2)
- 'Transfers the first item of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
- RadListBox1.Transfer(RadListBox2.Items(0), RadListBox2, RadListBox1);
-
-
-
-
-
- Moves the item at old index to new index.
- Fires the and events.
-
- The old (current) index of the item.
- The new index of the item.
-
- The Reorder method updates the underlying datasource if the is set to true.
-
-
-
- //Reorder the first item to second place
- RadListBox1.Reorder(0, 1);
-
-
- 'Reorder the first item to second place
- RadListBox1.Reorder(0, 1)
-
-
-
-
-
- Reorders the specified items with the specified offset.
- Fires the and events.
-
- The items.
- The offset.
-
- he Reorder method updates the underlying datasource if the is set to true.
-
-
-
- //Move all selected items with one position down
- RadListBox1.Reorder(RadListBox1.SelectedItems, 1);
-
-
- 'Move all selected items with one position down
- RadListBox1.Reorder(RadListbox1.SelectedItems, 1)
-
-
-
-
-
- Finds the first item for which the specified predicate returns true.
-
- The predicate which will test all items.
-
- The first item for which the specified predicate returns true. Null (Nothing) is returned if no item matches.
-
-
- The following example demonstrates how to use the FindItem method to find the first item whose starts with "A"
-
- RadListBoxItem item = RadListBox1.FindItem(delegate(RadListBoxItem currentItem) {
- return currentItem.Text.StartsWith("A");
- });
-
-
- Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadListBox1.FindItem(AddressOf Find)
- End Sub
- Public Function Find(ByVal currentItem As RadListBoxItem) As Boolean
- Find = currentItem.Text.StartsWith("A")
- End Function
-
-
-
-
-
- Finds the first item whose property is the same as the specified text.
-
- The text to search for.
-
- The first item whose property is the same as the specified text. Null (Nothing) otherwise.
-
-
-
-
- Finds the first item whose property is the same as the specified value.
-
- The value to search for.
-
- The first item whose property is the same as the specified value. Null (Nothing) otherwise.
-
-
-
-
- Clears the selection. The property of all items is set to false.
-
-
-
-
- Clears the checked items. The property of all items is set to false.
-
-
-
-
- Gets an array containing the indices of the currently selected items in the RadListBox control.
-
-
-
-
- Gets an array containing the indices of the currently checked items in the RadListBox control.
-
-
-
-
- Finds the index of the item whose property is the same as the specified value.
-
- The value.
-
- The index of the item whose property is the same as the specified value. -1 if no item is found.
-
-
-
-
- Finds the index of the item whose property is the same as the specified value.
-
- The value.
- if set to true case insensitive comparison is made.
-
- The index of the item whose property is the same as the specified value. -1 if no item is found.
-
-
-
- Sorts the items in the RadListBox.
-
-
-
- RadListBox1.Sort=RadListBoxSort.Ascending
- RadListBox1.SortItems()
-
-
- RadListBox1.Sort=RadListBoxSort.Ascending;
- RadListBox1.SortItems();
-
-
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Gets or sets a value indicating whether to update the underlying datasource after postback caused by reorder, delete or transfer.
-
-
- true if the datasource should be update; otherwise, false. The default value is false.
-
-
- Automatic updates require postback so the , or
- should be set to true depending on the requirements.
-
-
-
-
- Gets a object that stores the key values of each record.
-
- The data keys.
-
-
- The DataKeys property is populated after databinding if the property is set.
-
-
-
-
- Gets or sets a value indicating whether RadListBox should post back after delete.
-
-
- true if RadListBox should postback after delete; otherwise, false. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether RadListBox should post back after transfer.
-
-
- true if RadListBox should postback after transfer; otherwise, false. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether RadListBox should post back after reorder.
-
-
- true if RadListBox should postback after reorder; otherwise, false. The default value is false.
-
-
-
-
- Gets or sets the transfer mode used for transfer operations.
-
- The transfer mode. The default value is
-
- If the TransferMode property is set to the items would be deleted from the source listbox before
- inserting them in the destination listbox. The TransferMode property of the listbox whose property is set is taken into account.
-
-
-
-
- Gets or sets a value indicating whether the double click on a item causes transfer
-
-
- true if the user should be able to transfer items with double click; otherwise, false. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether the user can transfer the same item more than once.
-
-
- true if the user should be able to transfer the same item more than once; otherwise, false. The default value is false.
-
-
-
-
- Gets the which the current list box is configured to transfer to via the property.
-
-
- The transfer to list box. null (Nothing) if the property is not set.
-
-
-
-
- Gets or sets the ID of the which the current listbox should transfer to.
- Set the TransferToID property only of one of the two listboxes which will transfer items between each other.
-
- The ID of the target listbox.
-
-
-
- Gets or sets a value indicating whether RadListBox should persist the changes that occurred client-side (reorder, transfer, delete) after postback.
-
-
- true if client-side changes should be persisted after postback; otherwise, false. The default value is true.
-
-
-
-
- Used to customize the appearance and position of the buttons displayed by RadListBox.
-
-
-
-
- Gets or sets a value indicating whether RadListBox displays the reordering buttons.
-
-
- true if reordering UI is displayed; otherwise, false. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether RadListBox displays the delte button.
-
-
- true if delete button is displayed; otherwise, false. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether RadListBox displays the transfer buttons.
-
-
- true if transfer UI is displayed; otherwise, false. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically
- occurs when the user changes the RadListBox selection.
-
-
- Set this property to true if the server needs to capture the selection
- as soon as it is made. For example, other controls on the Web page can be
- automatically filled depending on the user's selection from a list control.
- This property can be used to allow automatic population of other controls on
- the Web page based on a user's selection from a list.
- The value of this property is stored in view state.
-
- The server-side event that is fired is
- SelectedIndexChanged.
-
-
-
-
-
- Gets the currently checked items in the ListBox.
-
-
-
-
- When set to true enables Drag-and-drop functionality
-
-
-
-
- Gets or sets the that defines the empty message template.
-
- The item template.
-
-
-
- Gets or sets the that defines how items in the control are displayed.
-
- The item template.
-
-
-
- Gets the items of the control.
-
- The object which represents the items.
-
- You can use the Items property to add and remove items in the control.
-
-
-
-
-
- Gets or sets the selected index of the control.
-
- The index that should be selected.
-
- Set the selected index to -1 to clear the selection.
-
-
-
-
- Gets the currently selected Item in the ListBox.
-
-
- A which is currently selected. Null (Nothing) if there is no selected item ( is -1).
-
-
-
-
- Gets the currently selected items in the ListBox.
-
-
-
-
- Gets the of the selected item.
- When set selects the item with matching property.
-
-
-
-
- Gets or sets the Selection Mode of the RadListBox.
-
-
-
-
- Automatically sorts items alphabetically (based on the Text
- property) in ascending or descending order.
-
-
-
- RadListBox1.Sort = RadListBoxSort.Ascending;
- RadListBox1.Sort = RadListBoxSort.Descending;
- RadListBox1.Sort = RadListBoxSort.None;
-
-
- RadListBox1.Sort = RadListBoxSort.Ascending
- RadListBox1.Sort = RadListBoxSort.Descending
- RadListBox1.Sort = RadListBoxSort.None
-
-
-
-
-
- Gets/sets whether the sorting will be case-sensitive or not.
- By default is set to true.
-
-
-
- RadListBox1.SortCaseSensitive = false;
-
-
-
- RadListBox1.SortCaseSensitive = false
-
-
-
-
-
- When set to true displays a checkbox next to each item.
-
-
-
-
- Gets a list of all client-side changes (adding an Item, removing an Item, changing an Item's property) which have occurred.
-
-
-
-
- Gets or sets the key field in the data source. Usually this is the database column which denotes the primary key.
-
- The name of the key field in the data source specified.
-
- DataKeyField is required for automatic data source updates during transfer, reorder and delete.
-
-
-
-
- Gets or sets the sort field in the data source. The sort field must be of numeric type.
-
- The name of the sort field in the data source specified.
-
- DataSortField is required for automatic data source updates during reorder.
-
-
-
-
- Occurs when items's sort order is updated during the reordering.
-
-
-
-
- Occurs when items's sort order is updated during the reordering.
-
-
-
-
- Occurs when items are deleted.
-
-
-
-
- Occurs when items are deleted.
-
-
-
-
- Occurs when item is transferred.
-
-
-
-
- Occurs when item is transferred. Can be cancelled by setting the property to true.
-
-
-
-
- Occurs when item is inserted.
-
-
-
-
- Occurs when item is inserted. Can be cancelled by setting the property to true.
-
-
-
-
- Occurs when item is reordered.
-
-
-
-
- Occurs when item is reordered. Can be cancelled by setting the property to true.
-
-
-
-
- Occurs before drag and drop
-
-
-
-
- Occurs after drag and drop
-
-
-
-
- Occurs when item is data bound.
-
-
- Use the ItemDataBound event to set additional properties of the databound items.
-
-
-
- protected void RadListBox1_ItemDataBound(object sender, RadListBoxItemEventArgs e)
- {
- e.Item.ToolTip = (string)DataBinder.Eval(e.Item.DataItem, "ToolTipColumn");
- }
-
-
- Protected Sub RadListBox1_ItemDataBound(sender As Object, e As RadListBoxItemEventArgs)
- e.Item.ToolTip = DirectCast(DataBinder.Eval(e.Item.DataItem, "ToolTipColumn"), String)
- End Sub
-
-
-
-
-
- Occurs when item is created.
-
-
- The ItemCreated event occurs before and after postback if ViewState is enabled.
- ItemCreated is not raised for items defined inline in the ASPX.
-
-
-
-
- Occurs when an item is checked
-
-
-
-
- Occurs when the selected index has changed.
-
-
-
-
- Occurs when text was changed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the selectedIndexChanging client-side event.
-
-
- The selectedIndexChanging client-side event occurs when the selection changes.
-
-
- The selectedIndexChanging event can be cancelled by setting its cancel client-side property to false.
-
- function onSelectedIndexChanging(sender, args)
- {
- args.set_cancel(true);
- }
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the selectedIndexChanged client-side event.
-
-
- The selectedIndexChanged client-side event occurs when the selection changes.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- before the browser context panel shows (after right-clicking an item).
-
-
- Use theOnClientContextMenu property to specify a JavaScript
- function that will be executed before the context menu shows after right clicking an
- item.
-
-
-
- function onContextMenu(sender, args)
- {
- var item = args.get_item();
- }
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the itemChecking client-side event.
-
-
- The itemChecking event occurs when the item is checked.
-
-
- The itemChecking event can be cancelled by setting its cancel client-side property to false.
-
- function onItemChecking(sender, args)
- {
- args.set_cancel(true);
- }
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the itemChecked client-side event.
-
-
- The itemChecked event occurs when the item is checked.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the deleting client-side event.
-
-
- The deleting event occurs when an items are deleted (during transfer or delete for example).
-
-
- The deleting event can be cancelled by setting its cancel client-side property to false.
-
- function onDeleting(sender, args)
- {
- args.set_cancel(true);
- }
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the deleted client-side event.
-
-
- The deleted event occurs when an itema are deleted (during transfer or delete for example).
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the transferring client-side event.
-
-
- The transferring event occurs when an item is transferred.
-
-
- The transferring event can be cancelled by setting its cancel client-side property to false.
-
- function onTransferring(sender, args)
- {
- args.set_cancel(true);
- }
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the transferred client-side event.
-
-
- The transferred event occurs when an item is transferred.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the reordering client-side event.
-
-
- The reordering event occurs when an item is reordered.
-
-
- The reordering event can be cancelled by setting its cancel client-side property to false.
-
- function onReordering(sender, args)
- {
- args.set_cancel(true);
- }
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the reordered client-side event.
-
-
- The reordered event occurs when an item is reordered.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the mouseOver client-side event.
-
-
- The mouseOver event occurs when the user hovers a listbox item with the mouse.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the mouseOut client-side event.
-
-
- The mouseOut event occurs when the user moves away the mouse from a listbox item.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the load client-side event.
-
-
- The load event occurs when RadListBox is initialized.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the itemDragStart client-side event.
-
-
- The itemDragStart event occurs when user starts to drag an item.
-
-
- The itemDragStart event can be cancelled by setting its cancel client-side property to false.
-
- function onItemDragStart(sender, args)
- {
- args.set_cancel(true);
- }
-
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the itemDragging client-side event.
-
-
- The itemDragging event occurs when user moves the mouse while dragging an item.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the itemDropping client-side event.
-
-
- The itemDropping event occurs when the user drops an item onto another item.
-
-
-
-
- Gets or sets the name of the JavaScript function which handles the itemDropped client-side event.
-
-
- The itemDropped event occurs after the user drops an item onto another item.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Represents an item in the control.
- Use the property to set the text of the item.
- Use the property to specify the value of the item.
-
-
-
-
- Initializes a new instance of the class.
-
-
-
-
- Initializes a new instance of the class.
-
- The text of the item.
-
-
-
- Initializes a new instance of the class.
-
- The text of the item.
- The value of the item.
-
-
-
- Clones this instance.
-
-
-
-
- Removes this from the control which contains it.
-
-
-
-
- Not supported
-
-
-
-
-
-
- Gets or sets the value of this .
-
-
- The value of the item. If the Value property is not set the will be returned.
-
-
-
-
- Gets the which this item belongs to.
-
-
- The which this item belongs to; null (Nothing) if the item is not added to any control.
-
-
-
- Gets or sets the path to an image to display for the item.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the ImageUrl property to specify the image for the item. If
- the ImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
-
- Gets or sets a value indicating whether this is selected.
-
- true if selected; otherwise, false.
-
-
-
- Gets or sets a value indicating whether the item is checked or not.
-
-
- True if the item is checked; otherwise false. The default value
- is false
-
-
-
-
- Gets or sets a value indicating whether the item is checkable. A checkbox control is rendered
- for checkable nodes.
-
-
- If the CheckBoxes property set to true, RadTreeView automatically displays a checkbox next to each node.
- You can set the Checkable property to false for nodes that do not need to display a checkbox.
-
-
-
-
- Gets or sets a value indicating whether the Item can be dragged and dropped.
-
-
- True if the user is able drag and drop the Item; otherwise false.
- The default value is true.
-
-
-
-
- Represents a collection of objects in a control.
-
-
-
-
- Initializes a new instance of the class.
-
- The parent control.
-
-
-
- Appends an item to the collection.
-
- The item to add to the collection.
-
-
-
- Inserts an item to the collection at the specified index.
-
- The zero-based index at which should be inserted.
- The item to insert into the collection.
-
-
-
- Finds all items mathcing the specified criteria.
-
- The delegate which determines whether an item matches the search criteria.
-
-
-
- Removes the specified item from the collection.
-
- The item to remove from the collection.
-
-
-
- Sort the items from RadListBoxItemCollection.
-
-
-
-
- Sort the items from RadListBoxItemCollection.
-
-
- An object from IComparer interface.
-
-
-
-
- Represents a collection of objects in a control.
-
-
-
-
- Represents a collection of objects in a control.
-
-
-
-
- Gets or sets the at the specified index.
-
-
-
- Override to fire the corresponding command.
-
-
- Gets or sets a value, defining whether the command should be canceled.
-
-
- For internal usage only.
-
-
-
- For internal usage only.
-
-
-
- Fires .SelectedIndexChanged event.
-
-
- For internal usage only.
-
-
-
- Fires .SelectedIndexChanged event.
-
-
-
- Holds reference to RadDataPagerFieldItem that contains current field controls.
-
-
-
-
- After calling this method DataPagerField controls will be created and added to Controls colleciton
- of the passed DataPagerFieldItem
-
- DataPagerFieldItem item where controls will be instanciated
-
-
-
- Builds navigation url if SEO paging is enabled.
-
- Argument that the link must be build for.
- Returns string representation of navigation url.
-
-
-
- Returns RadDataPager control that owns current pager field.
- This property is set by DataPagerFieldCollection and is read only.
-
-
-
-
- Gets the string representation of the type-name of this instance. The value is
- used by RadDataPager to determine the type of the pager field persisted into the ViewState, when
- recreating the pager after postback. This property is read only.
-
-
-
-
- Gets or sets value that indicates whether RadDataPagerField is rendered.
-
-
-
-
- Creates button control from one of the following type: LinkButton, PushButton, ImageButton
- or HyperLink if AllowSEOPaging is set to "true". Button Enabled state will be validated
- depending on current page index.
-
- PagerFieldButtonType enumerator
- Text shown as content the button control
- Tooltip of the button
- Command that button triggers
- Command argument which will be passed along with CommandName
- CssClass that will be applied on the button
- Returns button control of type: LinkButton, PushButton, ImageButton
- or HyperLink if SEO paging.
-
-
-
- Create button control for one of the following types: LinkButton, PushButton, ImageButton
-
-
-
-
- Create button of type HyperLink whenever AllowSEOPaging is set to "true".
-
-
-
-
- Sets content of HyperLink button if SEO paging is enabled, depending on commandArgument.
-
-
-
-
- Get reference to image from embeded resources. Internally used by PrepareSEOButtonContent method.
-
-
-
-
- Formats the text depending on PagerFieldButtonType. Text for LinkButton is wrapped with span tag.
-
- Value from PagerFieldButtonType enum.
- Text to be formatted.
- Returns string representing content of button.
-
-
-
- Ensures button Enabled property. If button command argumetn is same as current page, button
- will be disabled.
-
- Button instance to be validated.
- Command argument for the button.
- Returns same button with Enabled property set.
-
-
-
- This property specifies the type of the buttons for current pager field. Default value LinkButton.
-
-
-
-
- This method must be overriden in order to build controls for the current RadDataPagerField.
-
-
-
-
-
- Method for creating "Previous" button.
-
-
-
-
- Method for creating "Next" button.
-
-
-
-
- Method for creating "First" button.
-
-
-
-
- Method for creating "Last" button.
-
-
-
-
- Method for creating all numeric pager buttons.
-
-
-
-
- This property specifies the type of the field. Default value is PrevNext field type.
-
-
-
-
- This property specifies Next button text.
-
-
-
-
- This property specifies Prev button text.
-
-
-
-
- This property specifies First button text.
-
-
-
-
- This property specifies Last button text.
-
-
-
-
- This property specifies the number of the buttons for Numeric field type.
-
-
-
-
- Get or set RadNumericTextBox Width in pixels. Default value is 30px.
-
-
-
-
- Get or set text of the label before RadNumericTextBox.
-
-
-
-
- Get or set text of the lable after RaddNumericTextBox.
-
-
-
-
- Determines whether submit button should be render to change current page.
-
-
-
-
- Get or set submit button text if EnableSubmitButton is set to true.
-
-
-
-
- Get or set RadNumericTextBox Width in pixels. Default value is 30px.
-
-
-
-
- Get or set submit button text.
-
-
-
-
- Get or set text of the label.
-
-
-
-
- Get/Set the text of the label before RadComboBox
-
-
-
-
- Get/Set RadComboBox Width property in pixels. Default value is 50px.
-
-
-
-
- Get or set RadSlider DragText property.
-
-
-
-
- Get or set RadSlider DecreaseText property.
-
-
-
-
- Get or set RadSlider IncreaseText property.
-
-
-
-
- Get or set RadSlider orientation.
-
-
-
-
- This property contains template for RadDataPagerTemplateField.
- Container control is RadDataPagerFieldItem.
-
-
-
- This client-side event is fired after the
- is created.
-
-
- This client-side event is fired before the
- is created.
-
-
-
- This client-side event is fired when object is
- destroyed, i.e. on each window.onunload
-
-
-
-
- This client-side event is fired when current page index is set on
- object.
-
-
-
-
- This client-side event is fired when current page size is set on
- object.
-
-
-
-
- Holds reference to RadDataPagerField that is instanciated in current item.
-
-
-
-
- Holds reference to RadDataPager control.
-
-
-
-
- Raises event
-
-
-
-
-
- Triggers command on RadDataPager.
-
- Command that will be fired.
- Arguments of the command.
-
-
-
- Triggers command on RadDataPager.
-
- Command argument to be processed by RadDataPager
-
-
-
- Add listener to IRadPageableItemContainer events.
-
-
-
-
- This method is called when total row count is supplied by IRadPageableContainer.
-
- IRadPageableContainer itself
- DataPagerPageEventArgs arguments for creating pager fields
-
-
-
- This method is called to create all RadDataPager fields.
-
-
-
-
- This method checks query string for the key specified by SEOPagingQueryPageKey and
- if present attempt to page.
-
-
-
-
- Handles event that bubbles from any RadDataPagerField. Command event will be triggered.
-
-
-
-
-
-
-
- This method is called whenever any command bubbles from RadDataPagerField. If the command can be handled from RadDataPager
- it will return true and event bubbling will be prevented. If command name is custom return value will be false and command
- will continue to bubble.
-
- Could be any of the predefined RadDataPager commands or any custom command.
- Could be any of the predefined RadDataPager commands arguments or any custom argument.
- Return false will command should continue bubble or true if command is handled by RadDataPager.
-
-
-
- Raised when custom pager field is creating on postback
-
-
-
-
- Raised when pager field item is created.
-
-
-
-
- Raised when a button in a RadDataPager control is clicked.
-
-
-
-
- Read only property. Holds reference to control that implements
- IRadPageableItemContainer or IPageableItemContainer.
-
-
-
-
- Get or set query string key for SEO paging. This property may be used in conjunction with
- AllowSEOPaging
-
-
-
-
- Get or set whether SEO paging should be used.
-
-
-
-
- Method for settings paging properties of the pageable container
-
- The index of the first record on the page.
- The maximum number of items on a single page.
- true to rebind the control after the properties are set; otherwise, false.
-
-
-
- Occurs when the data from the data source is made available to the control.
-
-
-
-
- The maximum number of items to display on a single page
-
-
-
-
- The index of the first record that is displayed on a page
-
-
-
-
- Represents an individual data item in a control.
-
-
-
-
- Represents an individual item in a control.
-
-
-
-
- Use this method to simulate item command event that bubbles to
- and can be handled automatically or in a
- custom manner, handling .ItemCommand event.
-
- command to bubble, for example 'Page'
-
- command argument, for example 'Next'
-
-
-
-
- Gets a value indicating whether the item is in edit mode at the
- moment.
-
-
-
-
- Get the DataKeyValues from the owner with the corresponding item and .
- The should be one of the specified in the array
-
- data key name
- data key value
-
-
-
- Extracts values from this instance
- and appends them to passed collection
-
- This is dictionary to fill, this parameter
- should not be null
- newValues is null.
-
-
-
- Updates properties of the passed object instance from current
- 's extracted values
-
- object to be updated
- objectToUpdate is null.
-
-
-
- Gets the index of the data item bound to a control.
-
-
- An Integer representing the index of the data item in the data source.
-
-
-
-
- Gets the position of the data item as displayed in a control.
-
-
- An Integer representing the position of the data item as displayed in a control.
-
-
-
- Gets or set value indicating whether the
- item is selected
-
-
- Sets the Item in edit mode.
- Requires to rebind.
-
-
- Gets the old value of the edited item
-
-
-
- Represents an editable item
-
-
-
-
- Creates instance of RadListViewEditableItem
-
- instance which owns the item
- index at which the item is located on the current page
-
-
-
- Gets a value indicating whether the item is in edit mode at the
- moment.
-
-
-
-
- Represents an insert item
-
-
-
-
- Represents an item which is rendered when 's data source is empty
-
-
-
-
- Creates new instance of RadListViewEmptyDataItem
-
-
-
-
- Represents an item for the single group container
-
-
-
-
-
-
-
- InvalidOperationException.
-
-
-
-
-
-
- Cannot perform this
- operation when DataSource is not assigned
-
-
-
-
-
-
-
-
-
-
- Cannot find any bindable properties in an item from the datasource
-
-
- The method or operation is not implemented.
-
-
- The method or operation is not implemented.
-
-
- No value can be set to the property
-
-
- The method or operation is not implemented.
-
-
- The method or operation is not implemented.
-
-
- source is null.
-
-
- source is null.
-
-
- source is null.
-
-
-
- RadListView class
-
-
- RadListView class
-
-
-
-
- When overridden in an abstract class, creates the control hierarchy
- that is used to render the composite data-bound control based on the
- values from the specified data source.
-
-
- The number of items created by the
-
- .
-
- An
- that contains the
- values to bind to the control.
- true to indicate
- that the
-
- is called during data binding; otherwise, false.
-
- The
- control does not have an item placeholder
- specified.
-
-
-
- Creates a default
- object used
- by the data-bound control if no arguments are specified.
-
-
- A
- initialized to
- .
-
-
-
-
- Binds the data from the data source to the composite data-bound
- control.
-
- An
- that contains the values to bind to the composite data-bound
- control.
-
-
-
- InvalidOperationException.
-
-
- The RadListView control
- does not have an InsertItemTemplate template specified.
-
-
- There was a problem extracting
- DataKeyValues from the DataSource. Please ensure that DataKeyNames
- are specified correctly and all fields specified exist in the
- DataSource.
-
-
- InvalidOperationException.
-
-
- The RadListView control does not have an item placeholder specified.
-
-
- InvalidOperationException.
-
-
-
- Creates and instantiate layout template instance
-
- Created controls count
-
-
-
- Saves any control state changes that have
- occurred since the time the page was posted back to the server.
-
-
- Returns the 's current state. If there is
- no state associated with the control, this method returns null.
-
-
-
-
- Restores control-state information from a previous page request that
- was saved by the
- method.
-
- An that
- represents the control state to be restored.
-
-
-
- maximumRows is out of range.
- startRowIndex is out of range.
-
-
-
- Raises event
-
-
-
-
-
- Raises event
-
-
-
-
-
- Raises event
-
-
-
-
-
- Raises the event.
-
-
-
-
-
- Raises the event.
-
-
-
-
-
- Raises the event.
-
-
-
-
-
- Raises the event.
-
-
-
-
-
- Raises event
-
-
-
-
-
- Removes all selected items that belong to instance.
-
-
-
-
- Removes all edit items that belong to the
- instance.
-
-
-
-
- Handles the event.
-
- An object that contains the event data.
-
-
-
- Handles the event.
-
- An object that
- contains event data.
-
-
-
- Renders the to the specified HTML writer.
-
- The
- object that receives
- the control content.
-
-
-
- You should not call
- DataBind in event handler. DataBind would take place
- automatically right after handler finishes execution.
-
-
-
-
- The passed object (like for example) will be filled with the
- names/values of the corresponding 's bound values and data-key values if included.
-
- dataItem is null.
- newValues is null.
-
-
-
- Perform asynchronous update operation, using the control API and the
- Rebind method. Please, make sure you have specified the correct
- DataKeyNames for the . When the
- asynchronous operation calls back, will fire
- event.
-
-
-
-
- Perform asynchronous update operation, using the
- control API. Please make sure you have specified the correct
- DataKeyNames for the
- . When the asynchronous operation calls
- back, will fire
- event. The boolean
- property defines if will after
- the update.
-
- editedItem is
- null.
-
-
-
- Perform asynchronous delete operation, using the
- API the Rebinds the grid. Please
- make sure you have specified the correct
- for the
- . When the asynchronous operation calls
- back, will fire
- event.
-
-
-
-
- Perform delete operation, using the
- API. Please make sure you have specified the correct
- for the .
-
-
-
-
- Places the RadListView in insert mode, allowing user to insert a new data-item
- values.
-
-
-
-
- Places the RadListView in insert mode, allowing user to insert a new data-item
- values.
-
-
-
-
- Performs asynchronous insert operation, using the API, then
- Rebinds. When the asynchronous operation calls back, will fire
- event.
-
- Insert item is available only when RadListView is in insert mode.
-
-
-
- Performs asynchronous insert operation, using the API, then
- Rebinds. When the asynchronous operation calls back, will fire
- event.
-
- insertItem is null.
-
-
- container is null.
-
- -or-
- propName is null or an empty string ("").
-
-
- The object in container does not have the property specified by propName.
-
-
-
- InvalidOperationException.
-
-
-
-
-
-
-
- Gets or sets the custom content for the root container in a
- control.
-
-
-
-
- Gets or sets the custom content for the data item in a
- control.
-
-
-
-
- Gets or sets the custom content for the alternating data item in a control.
-
-
-
-
- Gets or sets the custom content for the item in edit mode.
-
-
- An object that contains the custom content for the item in edit
- mode. The default is null, which indicates that this property is not
- set.
-
-
-
-
- Gets or sets the custom content for an insert item in the
- control.
-
-
-
-
- Gets or sets the custom content for group container in the
- control.
-
-
-
-
- Gets or sets the user-defined content for the separator between
- groups in a control.
-
-
-
-
- Gets or sets the user-defined content for the empty item that is
- rendered in a control when there are no more data items to
- display in the last row of the current data page.
-
-
-
-
- Gets or sets the ID for the item placeholder in a
- control.
-
-
- The ID for the item placeholder in a control. The
- default is "itemPlaceholder".
-
-
-
-
- Gets or sets the ID for the group placeholder in a control.
-
-
- The ID for the group placeholder in a control. The
- default is "groupPlaceholder".
-
-
-
-
- Gets a collection of objects that represent
- the data items of the current page of data in a control.
-
-
-
-
- Gets or sets the custom content for the separator between the items
- in a control.
-
-
-
-
- Gets or sets the Template that will be displayed if there are no
- records in the DataSource assigned.
-
-
-
-
- Gets or sets the number of items to display per group in a
- control. Default value is 1
-
- value is out of range.
-
-
-
- Gets or sets an array of data-field names that will be used to
- populate the
- collection, when the
- control is databinding.
-
-
-
-
- Gets a reference to the
- object that allows
- you to set the properties of the client-side behavior and
- appearance in a Telerik control.
-
-
-
-
- Gets a collection of sort expressions for
-
-
-
-
- Gets or sets the value indicating if more than one datafield can
- be sorted. The order is the same as the sequence of expressions
- in .
-
-
-
-
- Gets or sets a value indicating the index of the currently active page in case
- paging is enabled ( is
- true).
-
- The index of the currently active page in case paging is enabled.
- AllowPaging Property
- value is out of range.
-
-
-
- Gets or sets a value indicating if the
- should override the default sorting
- with its native sorting.
-
-
- You can set this to true in case of
- with
- data without implemented sorting.
-
-
-
- Gets or sets if the custom sorting feature is enabled.
-
-
-
- Specify the maximum number of items that would appear in a page,
- when paging is enabled by property.
- Default value is 10.
-
- value is out of range.
-
-
-
- Gets the number of pages required to display the records of the data
- source in a control.
-
-
-
- value is out of range.
-
-
-
- Raised when is created
-
-
-
-
- Raised when is created
-
-
-
-
- Raised when is data bound
-
-
-
-
- Raised when a button in a control is clicked.
-
-
-
- Fires when a paging action has been performed.
-
-
- Fires when has been changed.
-
-
- Fires the SelectedIndexChanged event.
-
-
- Fires when has been changed.
-
-
-
- Occurs when an insert operation is requested, but before the
- control performs the insert.
-
-
-
-
- Occurs when an insert operation is requested, after the
- control has inserted the item in the data source.
-
-
-
-
- Occurs when an edit operation is requested, but before the
- item is put in edit mode
-
-
-
-
- Occurs when a delete operation is requested, but before the
- control deletes the item.
-
-
-
-
- Occurs when a delete operation is requested, after the
- control deletes the item.
-
-
-
-
- Occurs when the Update command is fired from any
-
-
-
-
- Occurs when the Update command is fired from any
-
-
-
-
- Occurs when the Cancel command is fired from any
-
-
-
-
- Raised when the is about to be bound and the data source must be assigned.
-
-
-
-
- Gets or sets a value indicating whether the automatic paging feature is
- enabled.
-
-
-
- Gets or sets a value indicating whether Telerik
- should retrieve all data and ignore server paging in
- case of sorting.
-
-
- true (default) if the retrieve all data feature
- is enabled; otherwise,
- false.
-
-
-
-
-
- Gets a reference to the
- object that allows you to set the properties of the validate
- operation in a control.
-
-
-
-
- Gets or sets the custom content for the selected item in a
- control.
-
-
-
- Gets a collection of indexes of the selected items.
-
-
-
- Gets or sets a value indicating whether you will be able to select multiple items
- in Telerik . By default this property is set to
- false.
-
-
- true if you can have multiple dataItems selected at once. Otherwise,
- false. The default is false.
-
-
-
- Gets a collection of the currently selected
- RadListViewDataItems
- Returns a of all
- selected data items.
-
-
- Gets the data key value of the selected item in a
- control.
- The data key value of the selected row in a
- control.
-
-
-
-
-
-
-
-
- Gets a collection of all in edit mode.
-
- of all items that are in edit
- mode.
-
-
-
- Gets or sets a value indicating whether RadListView will allow you
- to have multiple items in edit mode. The default value is
- false.
-
-
- true if you can have more than one item in edit
- mode. Otherwise,
- false. The default value is false.
-
-
-
-
- Gets or sets a value that indicates whether empty string values ("")
- are automatically converted to null values when the data field is
- updated in the data source.
-
-
-
-
- Gets or sets the location of the
- template when it is rendered as part of the
- control.
-
-
-
-
- Gets the insert item of a control.
-
-
-
-
- Specifies the function of an item in the control.
-
-
-
- This client-side event is fired after the
- is created.
-
-
- This client-side event is fired before the
- is created.
-
-
-
- This client-side event is fired when object is
- destroyed, i.e. on each window.onunload
-
-
-
- Gets a reference to class.
-
-
-
- Specifies the location of the InsertItemTemplate template when it is
- rendered as part of the control.
-
-
-
-
- Provides data for the ItemCreated and ItemDataBound events.
-
-
-
-
- Initializes a new instance of the RadListViewItemEventArgs class.
-
-
-
-
-
- The item being created or data-bound.
-
-
-
- Enumeration representing the order of sorting data in RadListView
-
-
- do not sort the listview data
-
-
- sorts listview data in ascending order
-
-
- sorts listview data in descending order
-
-
-
- Class that is used to define sort field and sort order for RadListView
-
-
-
-
-
-
-
-
- This method gives the string representation of the sorting order. It can be
- either "ASC" or "DESC"
-
-
-
-
- Returns a enumeration based on the string input. Takes either "ASC"
- or "DESC"
-
-
-
-
- This method gives the string representation of the sorting order. It can be
- either "ASC" or "DESC"
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the sort order.
- The SortOrder paremeter should be either "Ascending", "Descending" or "None".
-
- ArgumentException.
-
-
-
-
-
-
-
- Parses a string representation of the sort order and returns
- GirdSortExpression.
-
-
-
- Gets or sets the name of the field to which sorting is applied.
-
-
- Sets or gets the current sorting order.
-
-
-
- A collection of objects. Depending on the value of
- it holds single
- or multiple sort expressions.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns an enumerator that iterates through the
- RadListViewSortExpressionCollection.
-
-
-
- Adds a to the collection.
-
-
- Clears the RadListViewSortExpressionCollection of all items.
-
-
-
-
-
-
-
- Find a SortExpression in the collection if it contains any with sort field = expression
-
- sort field
-
-
-
-
- If is true adds the sortExpression in the collection.
- Else any other expression previously stored in the collection wioll be removed
-
-
-
-
-
- If is true adds the sortExpression in the collection.
- Else any other expression previously stored in the collection wioll be removed
-
- String containing sort field and optionaly sort order (ASC or DESC)
-
-
-
- Adds a to the collection at the specified
- index.
-
-
- As a convenience feature, adding at an index greater than zero will set the
- to true.
-
-
-
- Removes the specified from the collection.
-
-
-
- Returns true or false depending on whether the specified sorting expression exists
- in the collection. Takes a parameter.
-
-
-
-
- Returns true or false depending on whether the specified sorting expression
- exists in the collection. Takes a string parameter.
-
-
-
-
- Adds the sort field (expression parameter) if the collection does not alreqady contain the field. Else the sort order of the field will be inverted. The default change order is
- Asc -> Desc -> No Sort. The No-Sort state can be controlled using property
-
-
-
-
-
- Get a comma separated list of sort fields and sort-order, in the same format used by
- DataView.Sort string expression. Returns null (Nothing) if there are no sort expressions in the collection
-
- Comma separated list of sort fields and optionaly sort-order, null if there are no sort expressions in the collection
-
-
-
- Searches for the specified
- and
- returns the zero-based index of the first occurrence within the entire
- .
-
-
-
-
- If false, the collection can contain only one sort expression at a time.
- Trying to add a new one in this case will delete the existing expression
- or will change the sort order if its FiledName is the same.
-
-
-
- This is the default indexer of the collection - takes an integer value.
-
-
-
- Allow the no-sort state when changing sort order.
-
-
-
- Returns the number of items in the RadListViewSortExpressionCollection.
-
-
-
- Gets a value indicating whether access to the RadListViewSortExpressionCollection is
- synchronized (thread safe).
-
-
-
-
-
-
-
-
-
Gets an object that can be used to synchronize access to the
- GirdSortExpressionCollection.
-
-
-
-
-
-
- Represents a various validation setting of control
-
-
-
-
- Specifies the repeat direction of RadMenu items when rendered in columns.
-
-
-
-
- Items are displayed vertically in columns from top to bottom,
- and then left to right, until all items are rendered.
-
-
-
-
- Items are displayed horizontally in rows from left to right,
- then top to bottom, until all items are rendered.
-
-
-
-
- Represents the animation settings like type and duration for the control.
-
-
-
- Gets or sets the duration in milliseconds of the animation.
-
- An integer representing the duration in milliseconds of the animation.
- The default value is 450 milliseconds.
-
-
-
-
- Represents the animation settings like type and duration for the control.
-
-
-
- Gets or sets the duration in milliseconds of the animation.
-
- An integer representing the duration in milliseconds of the animation.
- The default value is 450 milliseconds
-
-
-
- A navigation control used for building collapsible side-menu systems and Outlook-type panels.
-
-
- The RadPanelBar control is used to display a list of items in a Web Forms
- page and is often used control for building collapsible side-menu
- interfaces. The RadPanelBar control supports the following features:
-
-
- Databinding that allows the control to be populated from various
- datasources
- Programmatic access to the RadPanelBar object model
- which allows to dynamic creation of panelbars, populate items, set
- properties.
- Customizable appearance through built-in or user-defined skins.
-
-
Items
-
- The RadPanelBar control is made up of tree of items represented
- by RadPanelItem objects. Items at the first level (level 0) are
- called root items. A items that has a parent item is called a child item. All root
- items are stored in the Items collection. Child items are
- stored in a parent item's Items collection.
-
-
- Each item has a Text and a Value property.
- The value of the Text property is displayed in the RadPanelBar control,
- while the Value property is used to store any additional data about the item,
- such as data passed to the postback event associated with the item. When clicked, a item can
- navigate to another Web page indicated by the NavigateUrl property.
-
-
-
-
-
- Defines properties that menu item containers (RadTreeView,
- RadPanelItem) should implement
-
-
-
- Gets the parent IMenuItemContainer.
-
-
- Gets the collection of child items.
-
- A RadPanelItemCollection that represents the child
- items.
-
-
- Use this property to retrieve the child items. You can also use it to
- programmatically add or remove items.
-
-
-
-
- Initializes a new instance of the RadPanelBar class.
-
-
- Use this constructor to create and initialize a new instance of the RadPanelBar
- control.
-
-
- The following example demonstrates how to programmatically create a RadPanelBar
- control.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadPanelBar RadPanelBar1 = new RadPanelBar();
- RadPanelBar1.ID = "RadPanelBar1";
-
- if (!Page.IsPostBack)
- {
- //RadPanelBar persist its item in ViewState (if EnableViewState is true).
- //Hence items should be created only on initial load.
-
- PadPanelItem sportItem= new PadPanelItem("Sport");
- RadPanelBar1.Items.Add(sportItem);
-
- PadPanelItem newsItem = new PadPanelItem("News");
- RadPanelBar1.Items.Add(newsItem);
- }
-
- PlaceHolder1.Controls.Add(newsItem);
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- Dim RadPanelBar1 As RadPanelBar = New RadPanelBar()
- RadPanelBar1.ID = "RadPanelBar1"
-
- If Not Page.IsPostBack Then
- 'RadPanelBar persist its item in ViewState (if EnableViewState is true).
- 'Hence items should be created only on initial load.
-
- Dim sportItem As PadPanelItem = New PadPanelItem("Sport")
- RadPanelBar1.Items.Add(sportItem)
-
- Dim newsItem As PadPanelItem = New PadPanelItem("News")
- RadPanelBar1.Items.Add(newsItem)
- End If
-
- PlaceHolder1.Controls.Add(newsItem)
- End Sub
-
-
-
-
-
- Populates the RadPanelBar control from external XML file.
-
-
- The newly added items will be appended after any existing ones.
-
-
- The following example demonstrates how to populate RadPanelBar control
- from XML file.
-
- private void Page_Load(object sender, EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- RadPanelBar1.LoadContentFile("~/RadPanelBar/Examples/panelbar.xml");
- }
- }
-
-
- Private Sub Page_Load(sender As Object, e As EventArgs) Handles MyBase.Load
- If Not Page.IsPostBack Then
- RadPanelBar1.LoadContentFile("~/RadPanelBar/Examples/panelbar.xml")
- End If
- End Sub
-
-
- The name of the XML file.
-
-
-
- Searches the RadPanelbar control for the first
- RadPanelItem with a Text property equal to
- the specified value.
-
-
- A RadPanelItem whose Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the RadPanelbar control for the first
- RadPanelItem with a Text property equal to
- the specified value.
-
-
- A RadPanelItem whose Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadPanelbar control for the first
- RadPanelItem with a Value property equal
- to the specified value.
-
-
- A RadPanelItem whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the RadPanelbar control for the first
- RadPanelItem with a Value property equal
- to the specified value.
-
-
- A RadPanelItem whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadPanelbar control for the first
- Item with a NavigateUrl
- property equal to the specified value.
-
-
- A RadPanelItem whose NavigateUrl
- property is equal to the specified value.
-
-
- The method returns the first Item matching the search criteria. If no Item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Returns the first RadPanelItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadPanel1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadPanelItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadPanel1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadPanelItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Gets a linear list of all items in the RadPanelBar
- control.
-
-
- An IList<RadPanelBarItem> containing all items (from all hierarchy
- levels).
-
-
- Use the GetAllItems method to obtain a linear collection of all
- items regardless their place in the hierarchy.
-
-
- The following example demonstrates how to disable all items within a
- RadPanelBar control.
-
- void Page_Load(object sender, EventArgs e)
- {
- foreach (RadPanelBarItem item in RadPanelBar1.GetAllItems())
- {
- item.Enabled = false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- For Each childItem As RadPanelBarItem In RadPanelBar1.GetAllItems
- childItem.Enabled = False
- Next
- End Sub
-
-
-
-
-
- This methods clears the selected items of the current RadPanelBar instance. Useful when you need to clear item selection after postback.
-
-
-
-
- This methods collapses all expanded panel items
-
-
-
-
- Raises the ItemClick event.
-
-
-
-
-
- Raises the ItemDataBound event.
-
-
-
-
-
- Raises the ItematCreated event.
-
-
-
-
-
- Gets a list of all client-side changes (adding an item, removing an item, changing an item's property) which have occurred.
-
-
- A list of objects which represent all client-side changes the user has performed.
- By default the ClientChanges property returns empty list. Client-changes are recorded if and only if the client-side
- methods trackChanges()/commitChanges() have been invoked.
-
-
- You can use the ClientChanges property to respond to client-side modifications such as
-
- adding a new item
- removing existing item
- clearing the children of an item or the control itself
- changing a property of the item
-
- The ClientChanges property is available in the first postback (ajax) request after the client-side modifications
- have taken place. After this moment the property will return empty list.
-
-
- The following example demonstrates how to use the ClientChanges property
-
- foreach (ClientOperation<RadPanelItem> operation in RadToolBar1.ClientChanges)
- {
- RadPanelItem item = operation.Item;
-
- switch (operation.Type)
- {
- case ClientOperationType.Insert:
- //An item has been inserted - operation.Item contains the inserted item
- break;
- case ClientOperationType.Remove:
- //An item has been inserted - operation.Item contains the removed item.
- //Keep in mind the item has been removed from the panelbar.
- break;
- case ClientOperationType.Update:
- UpdateClientOperation<RadPanelItem> update = operation as UpdateClientOperation<RadPanelItem>
- //The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- break;
- case ClientOperationType.Clear:
- //All children of have been removed - operation.Item contains the parent item whose children have been removed. If operation.Item is null then the root items have been removed.
- break;
- }
- }
-
-
- For Each operation As ClientOperation(Of RadPanelItem) In RadToolBar1.ClientChanges
- Dim item As RadPanelItem = operation.Item
- Select Case operation.Type
- Case ClientOperationType.Insert
- 'An item has been inserted - operation.Item contains the inserted item
- Exit Select
- Case ClientOperationType.Remove
- 'An item has been inserted - operation.Item contains the removed item.
- 'Keep in mind the item has been removed from the panelbar.
- Exit Select
- Case ClientOperationType.Update
- Dim update As UpdateClientOperation(Of RadPanelItem) = TryCast(operation, UpdateClientOperation(Of RadPanelItem))
- 'The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- Exit Select
- Case ClientOperationType.Clear
- 'All children of have been removed - operation.Item contains the parent item whose children have been removed. If operation.Item is Nothing then the root items have been removed.
- Exist Select
- End Select
- Next
-
-
-
-
-
- Gets a RadPanelItemCollection object that contains the root items of the current RadPanelBar control.
-
-
- A RadPanelItemCollection that contains the root items of the current RadPanelBar control. By default
- the collection is empty (RadPanelBar has no children).
-
-
- Use the Items property to access the child items of RadPanelBar. You can also use the Items property to
- manage the root items. You can add, remove or modify items from the Items collection.
-
-
- The following example demonstrates how to programmatically modify the properties of root items.
-
- RadPanelBar1.Items[0].Text = "Example";
- RadPanelBar1.Items[0].NavigateUrl = "http://www.example.com";
-
-
- RadPanelBar1.Items(0).Text = "Example"
- RadPanelBar1.Items(0).NavigateUrl = "http://www.example.com"
-
-
-
-
- Gets the selected panel item.
-
- Returns the panel item which is currently selected. If no item is selected
- the SelectedItem property will
- return null (Nothing in VB.NET).
-
-
-
-
- Gets or sets the template for displaying the items in
- RadPanelBar.
-
-
- A ITemplate implemented object that contains the template
- for displaying panel items. The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
- The ItemTemplate property sets a template that will be used
- for all panel items.
-
- To specify unique display for individual items use the
- ItemTemplate property of the
- RadPanelItem class.
-
-
-
- The following example demonstrates how to use the
- ItemTemplate property to add a CheckBox for each item.
- ASPX:
- <telerik:RadPanelBar runat="server" ID="RadPanelBar1">
-
- </telerik:RadPanelBar>
-
-
-
-
- Gets of sets a value indicating the behavior of RadPanelbar when an item is
- expanded.
-
-
- One of the PanelBarExpandMode Enumeration
- values. The default value is MultipleExpandedItems.
-
-
- Use the ExpandMode property to specify the way RadPanelbar
- should behave after an item is expanded. The available options are:
-
- MultipleExpandedItems (default) - More than one item can
- be expanded at a time.
- SingleExpandedItem - Only one item can be expanded at a
- time. Expanding another item collapses the previously expanded one.
- FullExpandedItem - Only one item can be expanded at a
- time. The expanded area occupies the entire height of the RadPanelbar. The
- Height property should be set in order
- RadPanelbar to operate correctly in this mode.
-
-
-
-
-
- Gets or sets a value indicating whether all items can be collapsed.
- This allows all the items to be collapsed even if the panelbar's ExpandMode is set to SingleExpandedItem or FullExpandedItem mode.
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when an item
- from the panel is clicked.
-
-
- The URL of the Web page to post to from the current page when an item from the
- panel control is clicked. The default value is an empty string (""), which causes
- the page to post back to itself.
-
-
-
-
- Gets or sets the maximum number of levels to bind to the RadPanelBar control.
-
-
- The maximum number of levels to bind to the RadPanelBar control. The default is -1, which binds all the levels in the data source to the control.
-
-
- When binding the RadPanelBar control to a data source, use the MaxDataBindDepth
- property to limit the number of levels to bind to the control. For example, setting this property to 2 binds only
- the root panel items and their immediate children. All remaining records in the data source are ignored.
-
-
-
-
- Gets or sets a value indicating whether the control would persists its state
- between pages (expanded and selected items).
-
-
- true if the control would persist its state;
- false otherwise. The default value is false.
-
-
- Use the PersistStateInCookie property to make
- RadPanelbar persist its state between pages. This feature requires
- browser cookies to be enabled. Also the ClientID and
- ID properties of the RadPanelbar control must be
- the same in all pages accessible via the control (and containing it).
- Page1.aspx:
- <radP:RadPanelbar ID="RadPanelbar1" > ...
- </radP:RadPanelbar>
- Page2.aspx
- <radP:RadPanelbar ID="RadPanelbar1" > ...
- </radP:RadPanelbar>
-
-
-
-
- Specifies the name of the cookie which should be used when PersistStateInCookie is set to true.
-
-
- If this property is not set the ClientID property will be used as the name of the cookie.
-
-
-
- Gets the settings for the animation played when an item opens.
-
- An AnnimationSettings that represents the
- expand animation.
-
-
-
- Use the ExpandAnimation property to customize the expand
- animation of RadPanelBar. You can specify the
- Type,
- Duration and the
- To disable expand animation effects you should set the
- Type to
- AnimationType.None.
- To customize the collapse animation you can use the
- CollapseAnimation property.
-
-
-
- The following example demonstrates how to set the ExpandAnimation
- of RadPanelBar.
-
- ASPX:
-
-
- <telerik:RadPanelBar ID="RadPanelBar1" runat="server">
- <ExpandAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadPanelBarItem Text="News" >
- <Items>
- <telerik:RadPanelBarItem Text="CNN" NavigateUrl="http://www.cnn.com"
- />
- <telerik:RadPanelBarItem Text="Google News" NavigateUrl="http://news.google.com"
- />
- </Items>
- </telerik:RadPanelBarItem>
- <telerik:RadPanelBarItem Text="Sport" >
- <Items>
- <telerik:RadPanelBarItem Text="ESPN" NavigateUrl="http://www.espn.com"
- />
- <telerik:RadPanelBarItem Text="Eurosport" NavigateUrl="http://www.eurosport.com"
- />
- </Items>
- </telerik:RadPanelBarItem>
- </Items>
-
-
- </telerik:RadPanelBar>
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadPanelBar1.ExpandAnimation.Type = AnimationType.Linear;
- RadPanelBar1.ExpandAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadPanelBar1.ExpandAnimation.Type = AnimationType.Linear
- RadPanelBar1.ExpandAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the timeout after which a panel item starts to
- open.
-
-
- An integer specifying the timeout measured in milliseconds. The default value is
- 0 milliseconds.
-
-
- Use the ExpandDelay property to delay item opening.
-
- To customize the timeout prior to item closing use the
- CollapseDelay property.
-
-
-
- The following example demonstrates how to specify a half second (500
- milliseconds) timeout prior to item opening:
- ASPX:
- <telerik:RadPanelBar ID="RadPanelBar1" runat="server"
- ExpandDelay="500" />
-
-
-
- Gets the settings for the animation played when an item closes.
-
- An AnnimationSettings that represents the
- collapse animation.
-
-
-
- Use the CollapseAnimation property to customize the expand
- animation of RadPanelBar. You can specify the
- Type,
- Duration and the
- items are collapsed.
- To disable expand animation effects you should set the
- Type to
- AnimationType.None. To customize the expand animation you can
- use the ExpandAnimation property.
-
-
-
- The following example demonstrates how to set the
- CollapseAnimation of RadPanelBar.
-
- ASPX:
-
-
- <telerik:RadPanelBar ID="RadPanelBar1" runat="server">
- <CollapseAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadPanelBarItem Text="News" >
- <Items>
- <telerik:RadPanelBarItem Text="CNN" NavigateUrl="http://www.cnn.com"
- />
- <telerik:RadPanelBarItem Text="Google News" NavigateUrl="http://news.google.com"
- />
- </Items>
- </telerik:RadPanelBarItem>
- <telerik:RadPanelBarItem Text="Sport" >
- <Items>
- <telerik:RadPanelBarItem Text="ESPN" NavigateUrl="http://www.espn.com"
- />
- <telerik:RadPanelBarItem Text="Eurosport" NavigateUrl="http://www.eurosport.com"
- />
- </Items>
- </telerik:RadPanelBarItem>
- </Items>
-
-
- </telerik:RadPanelBar>
-
-
-
-
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadPanelBar1.CollapseAnimation.Type = AnimationType.Linear;
- RadPanelBar1.CollapseAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadPanelBar1.CollapseAnimation.Type = AnimationType.Linear
- RadPanelBar1.CollapseAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the timeout after which a panel item starts to
- close.
-
-
- An integer specifying the timeout measured in milliseconds. The default value is
- 0 milliseconds.
-
-
-
- To customize the timeout prior to item closing use the
- ExpandDelay property.
-
-
-
- The following example demonstrates how to specify one second (1000
- milliseconds) timeout prior to item closing:
- ASPX:
- <telerik:RadPanelBar ID="RadPanelBar1" runat="server"
- CollapseDelay="1000" />
-
-
-
-
- Occurs on the server when an item in the RadPanelBar control is
- created.
-
-
- The ItemCreated event is raised every time a new item is
- added.
- The ItemCreated event is not related to data binding and you
- cannot retrieve the DataItem of the item in the event
- handler.
- The ItemCreated event is often useful in scenarios where you want
- to initialize all items - for example setting the ToolTip of each
- RadPanelBarItem to be equal to the Text property.
-
-
- The following example demonstrates how to use the ItemCreated
- event to set the ToolTip property of each item.
-
- private void RadPanelBar1_ItemCreated(object sender, Telerik.WebControls.RadPanelBarItemEventArgs e)
- {
- e.Item.ToolTip = e.Item.Text;
- }
-
-
- Sub RadPanelBar1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.WebControls.RadPanelBarItemEventArgs) Handles RadPanelBar1.ItemCreated
- e.Item.ToolTip = e.Item.Text
- End Sub
-
-
-
-
-
- Occurs on the server when a panel item in the RadPanelBar
- control is clicked.
-
-
-
- The panel will also postback if you navigate to a panel item
- using the [panel item] key and then press [enter] on the panel item that is focused. The
- instance of the clicked panel item is passed to the ItemClick event
- handler - you can obtain a reference to it using the eventArgs.RadPanelBarItem property.
-
-
-
-
- Occurs after a panel item is data bound.
-
-
- The ItemDataBound event is raised for each panel item upon
- databinding. You can retrieve the item being bound using the event arguments.
- The DataItem associated with the item can be retrieved using
- the DataItem property.
-
- The ItemDataBound event is often used in scenarios when
- you want to perform additional mapping of fields from the DataItem
- to their respective properties in the RadPanelBarItem class.
-
-
- The following example demonstrates how to map fields from the data item to
- RadPanelItem properties using the ItemDataBound
- event.
-
- private void RadPanelBar1_ItemDataBound(object sender, Telerik.WebControls.RadPanelBarEventArgs e)
- {
- RadPanelBarItem item = e.RadPanelBarItem;
- DataRowView dataRow = (DataRowView) e.Item.DataItem;
-
- item.ImageUrl = "image" + dataRow["ID"].ToString() + ".gif";
- item.NavigateUrl = dataRow["URL"].ToString();
- }
-
-
- Sub RadPanelBar1_ItemDataBound(ByVal sender As Object, ByVal e As RadPanelBarEventArgs) Handles RadPanelBar1.ItemDataBound
- Dim item As RadPanelBarItem = e.RadPanelBarItem
- Dim dataRow As DataRowView = CType(e.Item.DataItem, DataRowView)
-
- item.ImageUrl = "image" + dataRow("ID").ToString() + ".gif"
- item.NavigateUrl = dataRow("URL").ToString()
- End Sub
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- before the browser context panel shows (after right-clicking an item).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientContextMenu property to specify a JavaScript
- function that will be executed before the context menu shows after right clicking an
- item.
- Two parameters are passed to the handler
-
- sender (the client-side RadPanelbar object)
-
- eventArgs with two properties
-
-
Item - the instance of the selected item
-
EventObject - the browser DOM event
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientContextpanel property.
-
- <script language="javascript">
- function OnContextpanelHandler(sender, eventArgs)
- {
- var panelbar = sender;
- var item = eventArgs.Item;
-
- alert("You have right-clicked the " + item.Text + " item in the " + panelbar.ID +
- "panelbar.");
- }
- </script>
- <radP:RadPanelbar id="RadPanelbar1" runat="server"
- OnClientContextpanel="OnContextpanelHandler">
- <Items>
- <radP:RadPanelItem Text="Personal Details"></radP:RadPanelItem>
- <radP:RadPanelItem Text="Education"></radP:RadPanelItem>
- <radP:RadPanelItem Text="Computing Skills"></radP:RadPanelItem>
- </Items>
- </radP:RadPanelbar>
-
-
-
-
-
- This event is similar to OnClientItemFocus but fires only on
- mouse click.
- If specified, the OnClientItemClicking client-side event
- handler is called before a panel item is clicked upon. Two parameters are passed to
- the handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- The OnClientItemClicking event can be cancelled. To do so,
- return False from the event handler.
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a panel item is clicked.
-
-
- <script type="text/javascript">
- function OnClientItemClickingHandler(sender, eventArgs)
- {
- if (eventArgs.Item.Text == "News")
- {
- return false;
- }
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat="server"
- OnClientItemClicking="OnClientItemClickingHandler">
- ....
- </radP:RadPanelbar>
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after a panel item is clicked.
-
-
- This event is similar to OnClientItemFocus but fires only on
- mouse click.
- If specified, the OnClientItemClicked client-side event
- handler is called after a panel item is clicked upon. Two parameters are passed to
- the handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function OnClientItemClickedHandler(sender, eventArgs)
- {
- alert(eventArgs.Item.Text);
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat="server"
- OnClientItemClicked="OnClientItemClickedHandler">
- ....
- </radP:RadPanelbar>
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a panel item gets focus.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function OnClientItemFocusHandler(sender, eventArgs)
- {
- alert(eventArgs.Item.Text);
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat="server"
- OnClientItemFocus="OnClientItemFocusHandler">
- ....
- </radP:RadPanelbar>
-
-
- If specified, the OnClientItemFocus client-side event
- handler is called when a panel item is selected using either the keyboard (the
- [TAB] or arrow keys) or by clicking it. Two parameters are passed to the
- handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- This event cannot be cancelled.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after an item loses focus.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientItemBlur client-side event handler
- is called when a panel item loses focus as a result of the user pressing a key or
- clicking elsewhere on the page. Two parameters are passed to the handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function OnClientItemBlurHandler(sender, eventArgs)
- {
- alert(eventArgs.Item.Text);
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat="server"
- OnClientItemBlur="OnClientItemBlurHandler">
- ....
- </radP:RadPanelbar>
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a group of child items expands.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the OnClientItemOpen client-side event handler
- is called when a group of child items opens. Two parameters are passed to the
- handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function OnClientItemExpandHandler(sender, eventArgs)
- {
- alert(eventArgs.Item.Text);
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat="server"
- OnClientItemExpand="OnClientItemExpandHandler">
- ....
- </radP:RadPanelbar>
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- a group of child items collapses.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function OnClientItemCollapseHandler(sender, eventArgs)
- {
- alert(eventArgs.Item.Text);
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat="server"
- OnClientItemCollapse="OnClientItemCollapseHandler">
- ....
- </radP:RadPanelbar>
-
-
- If specified, the OnClientItemClose client-side event
- handler is called when a group of child items closes. Two parameters are passed to
- the handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- This event cannot be cancelled.
-
-
-
-
- If specified, the OnClienLoad client-side event handler is
- called after the panelbar is fully initialized on the client.
- A single parameter - the panelbar client object - is passed to the
- handler.
- This event cannot be cancelled.
-
-
- <script type="text/javascript">
- function OnClientLoadHandler(sender)
- {
- alert(sender.ID);
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat= "server"
- OnClientLoad= "OnClientLoadHandler">
- ....
- </radP:RadPanelbar>
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after the RadPanelbar client-side object is initialized.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse moves over a panel item in the RadPanelbar control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- If specified, the
- OnClientMouseOverclient-side event handler is
- called when the mouse moves over a panel item. Two parameters are passed to
- the handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the
- OnClientMouseOver property.
-
-
-
-
-
-
-
- If specified, the OnClientMouseOut client-side event handler
- is called when the mouse moves out of a panel item. Two parameters are passed to
- the handler:
-
- sender, the panelbar client object;
- eventArgs with one property, Item (the
- instance of the panel item).
-
- This event cannot be cancelled.
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse moves out of a panel item in the RadPanelbar control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- <script type="text/javascript">
- function OnClientMouseOutHandler(sender, eventArgs)
- {
- alert(eventArgs.Item.Text);
- }
- </script>
- <radP:RadPanelbar ID="RadPanelbar1"
- runat= "server"
- OnClientMouseOut= "OnClientMouseOutHandler">
- ....
- </radP:RadPanelbar>
-
-
-
-
- RadRating class
-
-
-
-
- Gets or sets a value indicating the server-side event handler that is called
- when the current rating of the RadRating control changes.
-
-
- A string specifying the name of the server-side event handler that will handle the
- event. The default value is an empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadRating object that raised the event.
- args.
-
-
-
- The following example demonstrates how to use the OnRate property.
-
-
-
-
-
-
-
- Adds HTML attributes and styles that need to be rendered to the specified . This method is used primarily by control developers.
-
- A that represents the output stream to render HTML content on the client.
-
-
-
- The Enabled property is reset in AddAttributesToRender in order
- to avoid setting disabled attribute in the control tag (this is
- the default behavior). This property has the real value of the
- Enabled property in that moment.
-
-
-
-
- Get/Set the number of items in the RadRating control - e.g. the number of stars that the control will have.
-
-
-
-
- Get/Set the current rating for the RadRating control.
-
-
-
-
- Get/Set the selection mode for the RadRating control - when the user rates, either mark a single item (star) as selected
- or all items(stars) from the first to the selected one.
-
-
-
-
- Get/Set the rating precision for the RadRating control - the precision with which the user can rate.
-
-
-
-
- Get/Set the orientation of the RadRating control.
-
-
-
-
- Get/Set the direction of the RadRating control, that is, the position of the item (star) with value 1.
-
-
-
-
- Get/Set a value indicating whether the RadRating control will display a browser toolip for its values.
-
-
-
-
- Get/Set a value indicating whether the RadRating control will initiate a postback after its value changes.
-
-
-
-
- Get/Set a value indicating whether the RadRating control is in read-only mode.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the RadRating control is initialized.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is an empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadRating object that raised the event.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientLoad property.
-
-
- <script type="text/javascript">
- function OnClientLoad(sender, args)
- {
- var ratingControl = sender;
- }
- </script>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when the user clicks an
- item (star) of the RadRating control, but before the new value is set.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is an empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadRating object that raised the event.
- args.
-
- This event can be cancelled.
-
-
- The following example demonstrates how to use the OnClientRating property.
-
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when the user clicks an
- item (star) of the RadRating control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is an empty string.
-
-
- Two parameters are passed to the handler:
-
- sender, the RadRating object that raised the event.
- args.
-
- This event cannot be cancelled.
-
-
- The following example demonstrates how to use the OnClientRated property.
-
-
- <script type="text/javascript">
- function OnClientRated(sender, args)
- {
- var ratingControl = sender;
- }
- </script>
-
-
-
-
-
-
- Specifies the possible values for the Precision property of the RadRating control.
-
-
-
-
- The user can select only the entire item (star).
-
-
-
-
- The user can select half an item (star) or the entire item (star).
-
-
-
-
- The user can select any portion of an item (star).
-
-
-
-
- Specifies the possible values for the SelectionMode property of the RadRating control.
-
-
-
-
- Only one item (star) is marked as selected - the currently selected item (star).
-
-
-
-
- Default behavior - all items (stars) from the first item (star) to the currently selected one are marked as selected.
-
-
-
-
- RadTicker control
-
-
-
-
- Binds the ticker to a IEnumerable data source
-
- IEnumerable data source
-
-
-
- The collection that holds all RadTickerItem objects.
-
-
-
-
- Specifies whether the ticker begins ticking automatically.
-
-
- You should leave this set to false if you are using the ticker within a RadTicker
- If you use the ticker independently and leave this setting to false you should use the
- client API call ticker_id.startTicker() to start it.
-
-
- Default: False
-
-
-
-
- Specifies whether will begin ticking the next tickerline
- (if any) after it has finished ticking the current one.
-
-
- If you set the AutoAdvance property to false, then you will have to use
- a client API Call ticker_id.tickNextLine()
-
-
- Default: True
-
-
-
-
- Specifies whether will repeat the first tickerline after displaying the last one.
-
-
- If you set this property to true RadTicker will never finish ticking.
- This may have possible implications when having more than one instance in
- a . This way works is that when the first ticker
- on a frame has finished ticking it will start ticking the next ticker on the frame. If a
- instance is ticking (has Loop=true) it will never finish and the next ticker on the frame will not get started.
-
-
- Default: False
-
-
-
-
- Specifies the duration in milliseconds between ticking each character of a tickerline.
- The lower the value the faster a line will finish ticking.
-
-
- Default: 20ms
-
-
-
-
- Specifies in milliseconds the pause makes before starting to tick
- the next line (if AutoAdvance=True).
-
-
- Default: 2000ms
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.
-
-
- Setting this property to true will make Telerik RadTicker postback to the server on item click.
-
-
- The default value is false.
-
-
-
-
- Gets or sets the field of the data source that provides the value of the ticker lines.
-
-
- A string that specifies the field of the data source that provides the value of the ticker lines.
- The default value is an empty string.
-
-
- Use the DataTextField property to specify the field of the data source (in most cases the name of the database column)
- which provides the values for the Text property of databound ticker items. The DataTextField property is
- taken into account only during data binding. If the DataTextField property is not set and your datasource is not a list of strings,
- the RadTicker control will throw an exception.
-
-
- The following example demonstrates how to use the DataTextField.
-
- DataTable data = new DataTable();
- data.Columns.Add("MyID");
- data.Columns.Add("MyValue");
-
- data.Rows.Add(new object[] {"1", "ticker item text 1"});
- data.Rows.Add(new object[] {"2", "ticker item text 2"});
-
- RadTicker1.DataSource = data;
- RadTicker1.DataTextField = "MyValue"; //"MyValue" column provides values for the Text property of databound ticker items
- RadTicker1.DataBind();
-
-
- Dim data As new DataTable();
- data.Columns.Add("MyID")
- data.Columns.Add("MyValue")
-
- data.Rows.Add(New Object() {"1", "ticker item text 1"})
- data.Rows.Add(New Object() {"2", "ticker item text 2"})
-
- RadTicker1.DataSource = data
- RadTicker1.DataTextField = "MyValue" '"MyValue" column provides values for the Text property of databound ticker items
- RadTicker1.DataBind()
-
-
-
-
-
- RadRotator Control
-
-
-
-
- Binds the rotator to a IEnumerable data source
-
- IEnumerable data source
-
-
-
-
-
-
-
- Specifies the type of rotator [how the rotator will render and what options the user will have for interacting with it on the client]
-
-
-
- Default: RotatorType.Buttons
-
-
-
-
- Specifies possible directions for scrolling rotator items.
-
-
-
- Default: RotatorScrollDirection.Left | RotatorScrollDirection.Right
-
-
-
-
- Specifies the speed in milliseconds for scrolling rotator items.
-
-
- Default: 500
-
-
-
-
- Specifies the index of the item, which will be shown first when the rotator loads.
- When set to 0 (default) - positions initial item to be visible in the rotator.
- When set to -1 - positions the initial item just outside of the rotator viewport.
- Any other positive value - the rotator starts with that particular item in the viewport.
-
-
- Default: 0
-
-
-
-
- Specifies the time in milliseconds each frame will display in automatic scrolling scenarios.
-
-
- Default: 2000
-
-
-
-
- Specifies the default rotator item width.
-
-
- Default: Unit.Empty
-
-
-
-
- Specifies the default rotator item height.
-
-
- Default: Unit.Empty
-
-
-
-
- Gets the settings for the web service used to populate items
-
-
- An WebServiceSettings that represents the
- web service used for populating items.
-
-
-
- Use the WebServiceSettings property to configure the web
- service used to populate items on demand.
- You must specify both Path and
- Method
- to fully describe the service.
-
-
- In order to use the integrated support, the web service should have the following signature:
-
-
- [ScriptService]
- public class WebServiceName : WebService
- {
- [WebMethod]
- public RadRotatorItemData[] WebServiceMethodName(int itemIndex, int itemCount)
- {
- List<RadRotatorItemData> result = new List<RadRotatorItemData>();
- RadRotatorItemData item;
- for (int i = 0; i < itemCount; i++)
- {
- item = new RadRotatorItemData();
- item.Html = "test "+(itemIndex+i);
- result.Add(item);
- }
- return result.ToArray();
- }
- }
-
-
-
-
-
-
- Gets or sets the height of the Web server control. The default height is 200 pixels.
-
-
-
-
- Gets or sets the width of the Web server control. The default width is 200 pixels.
-
-
-
-
- Gets or sets a value indicating whether a postback to the server automatically occurs when the user interacts with the control.
-
-
- Setting this property to true will make Telerik RadRotator postback to the server
- on item click.
-
-
- The default value is false.
-
-
-
-
- Gets or sets a value indicating whether to pause the rotator scrolling when the mouse is over a roatator item
-
-
- The default value is true. This means the animation will be paused when the user hovers over a rotator item.
-
-
-
-
- The name of the javascript function called when an item is clicked.
-
-
-
-
- The name of the javascript function called after an item is clicked.
-
-
-
-
- The name of the javascript function called when the mouse hovers over an item.
-
-
-
-
- The name of the javascript function called after the mouse leaves an item.
-
-
-
-
- The name of the javascript function called when an item is about to be shown.
-
-
-
-
- The name of the javascript function called after an item has been shown.
-
-
-
-
- The name of the javascript function called when the rotator is loaded on the client. The function
- is called right before the automatic animation (if used) begins.
-
-
-
-
- This class represents a item.
-
-
-
-
- Gets the zero based index of the item.
-
-
-
-
- A collection of RadTickerItem objects in a
- RadTicker control.
-
-
-
-
-
- Initializes a new instance of the RadTickerItemCollection class.
-
- The parent Ticker control.
-
-
- Gets or sets the effect that will be used for the animation.
-
-
- Gets or sets the animation duration in milliseconds.
-
-
-
- Returns the web.config value which specifies the application EnableEmbeddedScripts property.
-
-
- Telerik.[ShortControlName].EnableEmbeddedScripts or Telerik.EnableEmbeddedScripts, depending on which value was set.
-
-
-
-
- Returns the web.config value which specifies the application EnableEmbeddedSkins property.
-
-
- Telerik.[ShortControlName].EnableEmbeddedSkins or Telerik.EnableEmbeddedSkins, depending on which value was set.
-
-
-
-
- Specifies the type of the .
-
-
-
-
- An item has been inserted in the control.
-
-
-
-
- An item has been removed from the control.
-
-
-
-
- A property of the item has been changed.
-
-
-
-
- All children of the control or the item have been removed.
-
-
-
-
- An item has changed its position
-
-
-
-
- Used in case of update client operations.
-
- The type of the item (e.g. , ,
- , , , )
-
-
-
-
- Gets the name of the property which has been changed on the client side.
-
-
-
-
-
-
-
-
- Represents the settings to be used for load on demand through web service.
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the name of the web service to be used to populate items with
- ExpandMode set to WebService.
-
-
-
-
- Gets or sets the method name to be called to populate items with
- ExpandMode set to WebService.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets a boolean value
-
-
-
-
-
-
-
- Code taken from System.CodeDom.Compiler.CodeGenerator as the latter does not work in Medium trust
-
-
-
-
- Regular expression for detecting WebResource/ScriptResource substitutions in script files
-
-
-
-
- Outputs the combined script file requested by the HttpRequest to the HttpResponse
-
- A Page, representing the HttpHandler
- HttpContext for the transaction
- true if the script file was output
-
-
-
- Override this to process the pixel in the first pass of the algorithm
-
- The pixel to quantize
-
- This function need only be overridden if your quantize algorithm needs two passes,
- such as an Octree quantizer.
-
-
-
-
- Override this to process the pixel in the second pass of the algorithm
-
- The pixel to quantize
- The quantized value
-
-
-
- Retrieve the palette for the quantized image
-
- Any old palette, this is overrwritten
- The new color palette
-
-
-
- Struct that defines a 32 bpp colour
-
-
- This struct is used to read data from a 32 bits per pixel image
- in memory, and is ordered in this manner as this is the way that
- the data is layed out in memory
-
-
-
-
- Holds the blue component of the colour
-
-
-
-
- Holds the green component of the colour
-
-
-
-
- Holds the red component of the colour
-
-
-
-
- Holds the alpha component of the colour
-
-
-
-
- Permits the color32 to be treated as an int32
-
-
-
-
- Return the color for this Color32 object
-
-
-
-
- Construct the octree quantizer
-
-
- The Octree quantizer is a two pass algorithm. The initial pass sets up the octree,
- the second pass quantizes a color based on the nodes in the tree
-
- The maximum number of colors to return
- The number of significant bits
-
-
-
- Construct the octree
-
- The maximum number of significant bits in the image
-
-
-
- Add a given color value to the octree
-
-
-
-
-
- Reduce the depth of the tree
-
-
-
-
- Keep track of the previous node that was quantized
-
- The node last quantized
-
-
-
- Convert the nodes in the octree to a palette with a maximum of colorCount colors
-
- The maximum number of colors
- An arraylist with the palettized colors
-
-
-
- Get the palette index for the passed color
-
-
-
-
-
-
- Mask used when getting the appropriate pixels for a given node
-
-
-
-
- The root of the octree
-
-
-
-
- Number of leaves in the tree
-
-
-
-
- Array of reducible nodes
-
-
-
-
- Maximum number of significant bits in the image
-
-
-
-
- Store the last node quantized
-
-
-
-
- Cache the previous color quantized
-
-
-
-
- Get/Set the number of leaves in the tree
-
-
-
-
- Return the array of reducible nodes
-
-
-
-
- Class which encapsulates each node in the tree
-
-
-
-
- Construct the node
-
- The level in the tree = 0 - 7
- The number of significant color bits in the image
- The tree to which this node belongs
-
-
-
- Add a color into the tree
-
- The color
- The number of significant color bits
- The level in the tree
- The tree to which this node belongs
-
-
-
- Reduce this node by removing all of its children
-
- The number of leaves removed
-
-
-
- Traverse the tree, building up the color palette
-
- The palette
- The current palette index
-
-
-
- Return the palette index for the passed color
-
-
-
-
- Increment the pixel count and add to the color information
-
-
-
-
- Flag indicating that this is a leaf node
-
-
-
-
- Number of pixels in this node
-
-
-
-
- Red component
-
-
-
-
- Green Component
-
-
-
-
- Blue component
-
-
-
-
- Pointers to any child nodes
-
-
-
-
- Pointer to next reducible node
-
-
-
-
- The index of this node in the palette
-
-
-
-
- Get/Set the next reducible node
-
-
-
-
- Return the child nodes
-
-
-
-
- Summary description for TagSnippet.
-
-
-
-
- Summary description for HtmlParser.
-
-
-
-
- Summary description for TagSnippet.
-
-
-
-
- Summary description for TagSnippet.
-
-
-
-
- Summary description for TagSnippet.
-
-
-
-
- Summary description for TagSnippet.
-
-
-
-
- Allow the transfer of data files using the W3C's
- specification for HTTP multipart form data.
- Microsoft's version has a bug where it does not
- format the ending boundary correctly.
-
-
-
-
- Transmits a file to the web server stated
- in the URL property.
- You may call this several times and it will
- use the values previously set for fields and URL.
-
- the text to send
- The local path of
- the file to send.
-
-
-
- Initialize our class for use to
- send data files.
-
- The URL of the
- destination server.
-
-
-
- Used to signal we want the output to go to a
- text file verses being transfered to a URL.
-
- The local path to the
- output file.
-
-
-
- Allows you to add some additional field data
- to be sent along with the transfer.
- This is usually used for things like userid
- and password to validate the transfer.
-
- The name of the
- custom field.
- The value of the
- custom field.
-
-
-
- Allows you to add some additional header data
- to be sent along with the transfer.
-
- The name of the custom header.
- The value of the custom header.
-
-
-
- Determines if we have a file stream set, and
- returns either the HttpWebRequest stream or
- the file.
-
- Either the HttpWebRequest stream or
- the local output file.
-
-
-
- Make the request to the web server and
- retrieve it's response into a text buffer.
-
-
-
-
- Builds the proper format of the multipart
- data that contains the form fields and
- their respective values.
-
- All form fields, properly formatted
- in a string.
-
-
-
- Returns the proper content information for
- the file we are sending.
-
- The local path to
- the file that should be sent.
- All file headers, properly formatted
- in a string.
-
-
-
- Creates the proper ending boundary for the
- multipart upload.
-
- The ending boundary.
-
-
-
- Mainly used to turn the string into a byte
- buffer and then write it to our IO stream.
-
- The stream to write to.
- The data to place into the stream.
-
-
-
- Reads in the file a chunck at a time then
- sends it to the output stream.
-
- The stream to write to.
- The local path of the file to send.
-
-
-
- Allows you to specify the specific version
- of HTTP to use for uploads.
- The dot NET stuff currently does not allow
- you to remove the continue-100 header
- from 1.1 and 1.0 currently has a bug in it
- where it adds the continue-100.
- MS has sent a patch to remove the
- continue-100 in HTTP 1.0.
-
-
-
-
- Used to change the content type of the file
- being sent.
- Currently defaults to: text/xml. Other options
- are text/plain or binary.
-
-
-
-
- The string that defines the begining boundary
- of our multipart transfer as defined in the
- w3c specs.
- This method also sets the Content and Ending
- boundaries as defined by the w3c specs.
-
-
-
-
- The string that defines the content boundary
- of our multipart transfer as defined in the
- w3c specs.
-
-
-
-
- The string that defines the ending boundary
- of our multipart transfer as defined in the
- w3c specs.
-
-
-
-
- The data returned to us after the transfer
- is completed.
-
-
-
-
- The web address of the recipient of the
- transfer.
-
-
-
-
- Allows us to determine the size of the buffer
- used to send a piece of the file at a time
- out the IO stream.
- Defaults to 1024 * 10.
-
-
-
-
- Allows us to specified the credentials used
- for the transfer.
-
-
-
-
- Allows us to specifiy the certificate to use
- for secure communications.
-
-
-
-
- Gets or sets a value indicating whether to
- make a persistent connection to the
- Internet resource.
-
-
-
-
- Gets or sets a value indicating whether the
- Expect100-Continue header should be sent.
-
-
-
-
- Gets or sets a value indicating whether to
- pipeline the request to the Internet resource.
-
-
-
-
- Gets or sets a value indicating whether the
- file can be sent in smaller packets.
-
-
-
-
- Represents a EditorDropDownItem dropdown item from a custom editor dropdown
-
-
-
-
- A strongly typed collection of EditorDropDownItem objects
-
-
-
-
- Gets The text box instance created of extracted from a cell after calls to AddControlsToContainer or LoadControlsFromContainer methods.
-
-
-
-
- Gets The text box instance created of extracted from a cell after calls to AddControlsToContainer or LoadControlsFromContainer methods.
-
-
-
-
- Gets the instace of the Style that would be applied to the TextBox control, when initializing in a TableCell.
-
-
-
- Gets or sets default path for the GridDateTimeColumnEditor images when EnableEmbeddedSkins is set to false.
- A string containing the path for the grid images. The default is String.Empty.
-
-
-
-
-
-
-
-
-
- Gets or sets whether the column data can be filtered. The default value is
- true.
-
-
- A Boolean value, indicating whether the column can be
- filtered.
-
-
-
- Gets or sets a whether the column data can be sorted.
-
- A boolean value, indicating whether the column data can
- be sorted.
-
-
-
-
- Gets or sets a string, representing a comma-separated enumeration of DataFields
- from the data source, which will form the expression.
-
-
- A string, representing a comma-separated enumeration of
- DataFields from the data source, which will form the expression.
-
-
-
-
- Gets or sets aggregate result.
-
-
-
-
-
-
-
-
- Data class used for transferring rotator items from and to web services.
-
-
- For information about the role of each property see the
- RadRotatorItem class.
-
-
-
-
- The HTML content of the rotator frame. Note that you do not need to use templates here - the HTML will be added to the page directly.
-
-
-
-
- See RadRotatorItem.Visible.
-
-
-
-
- See RadRotatorItem.CssClass.
-
-
-
-
- This class represents a item.
-
-
-
-
- Gets the zero based index of the item.
-
-
-
-
- A collection of RadRotatorItem objects in a
- RadRotator control.
-
-
-
-
-
- Initializes a new instance of the RadRotatorItemCollection class.
-
- The parent Rotator control.
-
-
-
- Encapsulates the properties used for the RadRotator control buttons management.
-
-
-
-
- this function tries to get the client id of a control in the same naming container
-
- the control id
- the control to search in
- the client id if the control is found, or the input parameter if the control does not exist
-
-
-
- The name of the javascript function called when the user clicks one of the control buttons.
-
- This event is raised only when the rotator is in Buttons mode!
-
-
-
- The name of the javascript function called when the mouse is over one of the control buttons.
-
- This event is raised only when the rotator is in ButtonsOver mode!
-
-
-
- The name of the javascript function called when the mouse leaves one of the control buttons.
-
- This event is raised only when the rotator is in ButtonsOver mode!
-
-
-
- Minimal implementation of ISchedulerOperationResult.
-
-
- The type of the appointment data transfer object in use.
- Typically this is AppointmentData
- or derived class.
-
-
-
-
- This interface defines an operation result contract that
- can be optionally used by the web service methods.
-
-
- Implementers can extend it with additional data fields to
- report status and to transfer additional metadata.
- See the online documentation for more details.
-
-
- The type of the appointment data transfer object in use.
- Typically this is AppointmentData
- or derived class.
-
-
-
-
- A data transfer object used for Web Service data binding.
-
-
-
-
- A context menu control used with the control.
-
-
-
- The RadSchedulerContextMenu object is used to assign context menus to appointments. Use the
- property to add context menus for a
- object.
-
-
- Use the property to assign specific context menu to a given .
-
-
-
- The following example demonstrates how to add context menus declaratively
-
- <telerik:RadTreeView ID="RadTreeView1" runat="server">
- <ContextMenus>
- <telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <telerik:RadMenuItem Text="Menu1Item1"></telerik:RadMenuItem>
- <telerik:RadMenuItem Text="Menu1Item2"></telerik:RadMenuItem>
- </Items>
- </telerik:RadTreeViewContextMenu>
- <telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <telerik:RadMenuItem Text="Menu2Item1"></telerik:RadMenuItem>
- <telerik:RadMenuItem Text="Menu2Item2"></telerik:RadMenuItem>
- </Items>
- </telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- <telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeNode>
- <telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- <telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeView>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- OnClientItemClicking is not available for RadSchedulerContextMenu. Use the OnClientContextMenuItemClicking property of RadScheduler instead.
-
-
-
-
- OnClientItemClicked is not available for RadSchedulerContextMenu. Use the OnClientContextMenuItemClicked property of RadScheduler instead.
-
-
-
-
- OnClientShowing is not available for RadSchedulerContextMenu. Use the OnClientContextMenuShowing property of RadScheduler instead.
-
-
-
-
- OnClientShown is not available for RadSchedulerContextMenu. Use the OnClientContextMenuShown property of RadScheduler instead.
-
-
-
-
- Provides a collection container that enables RadScheduler to maintain a list of its RadSchedulerContextMenus.
-
-
-
-
- Initializes a new instance of the RadSchedulerContextMenuCollection class for the specified RadScheduler.
-
- The RadScheduler that the RadSchedulerContextMenuCollection is created for.
-
-
-
- Adds the specified RadSchedulerContextMenu object to the collection
-
- The RadSchedulerContextMenu to add to the collection
-
-
-
- Determines whether the specified RadSchedulerContextMenu is in the parent
- RadScheduler's RadSchedulerContextMenuCollection object.
-
- The RadSchedulerContextMenu to search for in the collection
- true if the specified RadSchedulerContextMenu exists in
- the collection; otherwise, false.
-
-
-
- Copies the RadSchedulerContextMenu instances stored in the
- RadSchedulerContextMenuCollection
- object to an System.Array object, beginning at the specified index location in the System.Array.
-
- The System.Array to copy the RadSchedulerContextMenu instances to.
- The zero-based relative index in array where copying begins
-
-
- Appends the specified array of objects to the end of the
- current .
-
-
- The array of to append to the end of the current
- .
-
-
-
-
- Retrieves the index of a specified RadSchedulerContextMenu object in the collection.
-
- The RadSchedulerContextMenu
- for which the index is returned.
- The index of the specified RadSchedulerContextMenu
- instance. If the RadSchedulerContextMenu is not
- currently a member of the collection, it returns -1.
-
-
-
- Inserts the specified RadSchedulerContextMenu object
- to the collection at the specified index location.
-
- The location in the array at which to add the RadSchedulerContextMenu instance.
- The RadSchedulerContextMenu to add to the collection
-
-
-
- Removes the specified RadSchedulerContextMenu
- from the parent RadScheduler's RadSchedulerContextMenuCollection
- object.
-
- The RadSchedulerContextMenu to be removed
- To remove a control from an index location, use the RemoveAt method.
-
-
-
- Removes a child RadSchedulerContextMenu, at the
- specified index location, from the RadSchedulerContextMenuCollection
- object.
-
- The ordinal index of the RadSchedulerContextMenu
- to be removed from the collection.
-
-
-
- Gets a reference to the RadSchedulerContextMenu at the specified index location in the
- RadSchedulerContextMenuCollection object.
-
- The location of the RadSchedulerContextMenu in the RadSchedulerContextMenuCollection
- The reference to the RadSchedulerContextMenu.
-
-
-
- Represents the method that handles the ContextMenuItemClick
- event of a RadTreeView control.
-
- The source of the event.
- A RadTreeViewContextMenuEventArgs
- that contains the event data.
-
-
- The ContextMenuItemClick event is raised
- when an item in the RadTreeViewContextMenu of the
- RadTreeView control is clicked.
-
-
- A click on a RadTreeViewContextMenu item of the
- RadTreeView makes a postback only if an event handler is attached
- to the ContextMenuItemClick event.
-
-
-
- The following example demonstrates how to display information about the clicked item in the
- RadTreeViewContextMenu shown after a right-click
- on a RadTreeNode.
-
- <%@ Page Language="C#" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- void RadTreeView1_ContextMenuItemClick(object sender, RadTreeViewContextMenuEventArgs e)
- {
- lblInfo.Text = string.Format(@"You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")",
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text);
- }
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
- <%@ Page Language="VB" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- Sub RadTreeView1_ContextMenuItemClick(ByVal sender as Object, ByVal e as RadTreeViewContextMenuEventArgs)
- lblInfo.Text = String.Format("You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")", _
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text)
- End Sub
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
-
-
-
- Provides data for the ContextMenuItemClick
- event of the RadTreeView control. This class cannot be inherited.
-
-
-
- The ContextMenuItemClick event is raised
- when an item in the RadTreeViewContextMenu of the
- RadTreeView control is clicked.
-
-
- A click on a RadTreeViewContextMenu item of the
- RadTreeView makes a postback only if an event handler is attached
- to the ContextMenuItemClick event.
-
-
-
- The following example demonstrates how to display information about the clicked item in the
- RadTreeViewContextMenu shown after a right-click
- on a RadTreeNode.
-
- <%@ Page Language="C#" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- void RadTreeView1_ContextMenuItemClick(object sender, RadTreeViewContextMenuEventArgs e)
- {
- lblInfo.Text = string.Format(@"You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")",
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text);
- }
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
- <%@ Page Language="VB" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- Sub RadTreeView1_ContextMenuItemClick(ByVal sender as Object, ByVal e as RadTreeViewContextMenuEventArgs)
- lblInfo.Text = String.Format("You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")", _
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text)
- End Sub
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
-
-
-
- Initializes a new instance of the RadTreeViewContextMenuEventArgs class.
-
- A RadTreeNode which represents a
- node in the RadTreeView control.
-
- A RadMenuItem which represents an
- item in the RadTreeViewContextMenu control.
-
-
-
-
- Gets the referenced RadMenuItem in the
- RadTreeViewContextMenu control
- when the event is raised.
-
-
- Use this property to programmatically access the item referenced in the
- RadTreeViewContextMenu when the event is raised.
-
-
-
-
- Gets the referenced RadTreeNode in the
- RadTreeView control when the event is raised.
-
-
- Use this property to programmatically access the item referenced in the
- RadTreeNode when the event is raised.
-
-
-
-
- Gets the master appointment that was used to generate the occurrence.
-
- The master appointment that was used to generate the occurrence.
-
-
-
- Gets the occurrence appointment that is about to be removed.
-
- The occurrence appointment that is about to be removed.
-
- This can also be the master appointment itself. If this is the case,
- it'll remain in the Appointments collection, but it will be hidden (Visible=false).
-
-
-
-
- Gets or sets the ISchedulerInfo object
- that will be passed to the web service.
-
-
- The ISchedulerInfo object
- that will be passed to the web service.
-
-
- You can replace this object with your own implementation of
- ISchedulerInfo in order
- to pass additional information to the Web Service.
-
-
-
-
- Gets or sets the URI for the request that is about to be made by a RadScheduler.
-
-
- The URI for the request that is about to be made by a RadScheduler.
-
-
- This property contains the absolute URI for the request, as resolved
- by RadScheduler. You might need to modify this URI to accommodate for
- URL rewriters and other scenarios.
-
-
-
-
- Gets a collection of header name/value pairs associated with the request.
-
-
- A WebHeaderCollection containing
- header name/value pairs associated with this request.
-
-
- The Headers property contains a WebHeaderCollection
- instance containing header information that RadScheduler sends with the request.
-
-
-
-
- Gets or sets the network credentials that are sent to the host and used to authenticate the request.
-
-
- An ICredentials containing the authentication credentials for the request.
- The default is a null reference (Nothing in Visual Basic).
-
-
- Typically, you would set this property to the credentials of the client on whose behalf the request is made.
-
-
-
-
- Gets or sets a value indicating the resource key to match.
-
-
- Resource key to match.
-
-
-
-
- Gets or sets a value indicating the resource text to match.
-
-
- Resource text to match.
-
-
-
-
- Gets or sets a value indicating the resource type to match.
-
-
- Resource type to match.
-
-
-
-
- Gets or sets a value indicating the cascading style sheet (CSS) class
- to render for appointments that use the matching resource.
-
-
- The cascading style sheet (CSS) class to render for appointments
- that use the matching resource.
-
- The default value is Empty.
-
-
- You can define your own CSS class name or use some of the predefined class names:
-
- rsCategoryRed
- rsCategoryBlue
- rsCategoryOrange
- rsCategoryGreen
-
-
-
-
-
- Specifies the resource population mode of a RadScheduler control when using Web Service data binding.
-
-
-
-
- In manual mode RadScheduler will not request resources from the Web Service.
- They can be populated from the code-behind of the ASP.NET page that hosts
- the RadScheduler control.
-
-
- This mode is useful when server-side requests from the server are undesirable
- or forbidden (Medium Trust for example).
-
-
-
-
- The resources will be populated from the server by issuing a request to
- the Web Service.
-
-
- The ResourcesPopulating
- event will be raised.
-
-
-
-
- The resources will be populated from the client by issuing a request to
- the Web Service.
-
-
- The ResourcesPopulating
- client-side event will be raised.
- Grouped views are not supported in this mode.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets the method name to be called to populate the appointments.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets the method name to be called to delete appointments.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets the method name to be called to insert appointments.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets the method name to be called to update appointments.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets the method name to be called to get the resources list.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets the method name to be called to create recurrence exceptions.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets the method name to be called to remove the recurrence exceptions of a given appointment.
-
-
- The method must be part of the web service specified through the
- Path property.
-
-
-
-
- Gets or sets the resource population mode
- to be used from RadScheduler.
-
-
- The resource population mode
- to be used from RadScheduler. The default value is
- ClientSide
-
-
-
- Resources need to be populated from the server when using resource grouping.
- Doing so also reduces the client-side initialization time.
-
-
- This operation requires the WebPermission to be granted
- for the Web Service URL. This permission is not granted by default in Medium Trust.
-
-
- You can disable the population of the resources from the server and still use
- client-side rendering for grouped views. To do so you need to set the
- value to Manual and
- populate the resources from the OnInit method of the page.
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
-
-
-
-
-
- The WebServiceAppointmentController provides a facade over a object
- and is used to call your provider from web services.
-
-
-
-
- Instantiates a new based on the default provider configured
- in web.config.
-
-
- If there is no provider configured in the web.config file a will be thrown.
-
-
-
-
- Instantiates a new by using the specified provider name.
-
- The name of the provider configured in web.config
-
-
-
- Instantiates a new based on the supplied
-
- The provider which will be used
-
-
- XmlSchedulerProvider provider = new XmlSchedulerProvider(Server.MapPath("~/App_Data/data.xml"), true);
- WebServiceAppointmentController controller = new WebServiceAppointmentController(provider);
-
-
- Dim provider As New XmlSchedulerProvider(Server.MapPath("~/App_Data/data.xml"), True)
- Dim controller As New WebServiceAppointmentController(provider)
-
-
-
-
-
- Gets the appointments corresponding to specified time period
-
- Contains the current time period
-
-
- [WebMethod]
- public IEnumerable<AppointmentData> GetAppointments(SchedulerInfo schedulerInfo)
- {
- return Controller.GetAppointments(schedulerInfo);
- }
-
-
- <WebMethod> _
- Public Function GetAppointments(schedulerInfo As SchedulerInfo) As IEnumerable(Of AppointmentData)
- Return Controller.GetAppointments(schedulerInfo)
- End Function
-
-
-
-
-
- Inserts the specified appointment and returns the available appointments.
-
- A object which contains the current time period.
- A object which contains the appointment properties.
-
-
- [WebMethod]
- public IEnumerable<AppointmentData> InsertAppointment(SchedulerInfo schedulerInfo, AppointmentData appointmentData)
- {
- return Controller.InsertAppointment(schedulerInfo, appointmentData);
- }
-
-
- <WebMethod> _
- Public Function InsertAppointment(schedulerInfo As SchedulerInfo, appointmentData As AppointmentData) As IEnumerable(Of AppointmentData)
- Return Controller.InsertAppointment(schedulerInfo, appointmentData)
- End Function
-
-
-
-
-
- Updates the specified appointment and returns the available appointments.
-
- A object which contains the current time period.
- A object which contains the appointment properties.
-
-
- [WebMethod]
- public IEnumerable<AppointmentData> UpdateAppointment(SchedulerInfo schedulerInfo, AppointmentData appointmentData)
- {
- return Controller.UpdateAppointment(schedulerInfo, appointmentData);
- }
-
-
- <WebMethod> _
- Public Function UpdateAppointment(schedulerInfo As SchedulerInfo, appointmentData As AppointmentData) As IEnumerable(Of AppointmentData)
- Return Controller.UpdateAppointment(schedulerInfo, appointmentData)
- End Function
-
-
-
-
-
- Creates a recurrence exception with the specified appointment data and returns the available appointments.
-
- A object which contains the current time period.
- A object which contains the exception properties.
-
-
- [WebMethod]
- public IEnumerable<AppointmentData> CreateRecurrenceException(SchedulerInfo schedulerInfo, AppointmentData recurrenceExceptionData)
- {
- return Controller.CreateRecurrenceException(schedulerInfo, recurrenceExceptionData);
- }
-
-
- <WebMethod> _
- Public Function CreateRecurrenceException(schedulerInfo As SchedulerInfo, recurrenceExceptionData As AppointmentData) As IEnumerable(Of AppointmentData)
- Return Controller.CreateRecurrenceException(schedulerInfo, recurrenceExceptionData)
- End Function
-
-
-
-
-
- Removes all recurrence exceptions of the specified recurrence master and returns the available appointments.
-
- A object which contains the current time period.
- A object which is the recurrence master.
-
-
- [WebMethod]
- public IEnumerable<AppointmentData> RemoveRecurrenceExceptions(SchedulerInfo schedulerInfo, AppointmentData masterAppointmentData)
- {
- return Controller.RemoveRecurrenceExceptions(schedulerInfo, masterAppointmentData);
- }
-
-
- <WebMethod> _
- Public Function RemoveRecurrenceExceptions(schedulerInfo As SchedulerInfo, masterAppointmentData As AppointmentData) As IEnumerable(Of AppointmentData)
- Return Controller.RemoveRecurrenceExceptions(schedulerInfo, masterAppointmentData)
- End Function
-
-
-
-
-
- Returns the resources of all appointments within the specified time period.
-
- The time period
-
-
-
- Deletes the specified appointment and returns the available appointments.
-
- A object which contains the current time period.
- A which represents the apointment that shoud be deleted.
- Specified wether to delete the recurring series if the specified appointment is recurrence master.
-
-
- [WebMethod]
- public IEnumerable<AppointmentData> DeleteAppointment(SchedulerInfo schedulerInfo, AppointmentData appointmentData, bool deleteSeries)
- {
- return Controller.DeleteAppointment(schedulerInfo, masterAppointmentData, deleteSeries);
- }
-
-
- <WebMethod> _
- Public Function DeleteAppointment(schedulerInfo As SchedulerInfo, appointmentData As AppointmentData, deleteSeries As Bool) As IEnumerable(Of AppointmentData)
- Return Controller.DeleteAppointment(schedulerInfo, masterAppointmentData, deleteSeries)
- End Function
-
-
-
-
-
- A factory for appointment instances.
-
-
-
- The default factory returns instances of the
- Appointment class.
-
-
- WebServiceAppointmentController needs to create appointment instances
- before passing them to the provider. You can use custom appointment
- classes by implementing an IAppointmentFactory and setting this property.
-
-
-
-
-
-
-
-
-
- Gets or sets a value indicating whether the user can use the advanced insert/edit form.
-
- true if the user should be able to use the advanced insert/edit form; false otherwise. The default value is true.
-
-
-
- Gets or sets a value indicating whether advanced form is displayed as a modal dialog.
-
-
- true if the advanced form is displayed as a modal dialog;
- false if the advanced form replaces the scheduler content.
- The default value is false.
-
-
-
-
- Gets or sets a value indicating the z-index of the modal dialog.
-
-
- An integer value that specifies the desired z-index.
- The default value is 2500.
-
-
- Use this property to position the form over elements with higher z-index
- than the modal form.
-
-
-
-
- Gets or sets a value that indicates whether the resource editing in the advanced form is enabled.
-
- A value that indicates whether the resource editing in the advanced form is enabled.
-
-
-
- Gets or sets a value that indicates whether the attribute editing in the advanced form is enabled.
-
- A value that indicates whether the attribute editing in the advanced form is enabled.
-
-
-
- Gets or sets the edit form date format string.
-
-
- The default value of this property is inferred from the
- Thread.CurrentThread.CurrentCulture.DateTimeFormat.ShortDatePattern
- property.
-
- The edit form date format string.
-
-
-
- Gets or sets the edit form time format string.
-
-
- The default value of this property is inferred from the
- Thread.CurrentThread.CurrentCulture.DateTimeFormat.ShortTimePattern
- property.
-
- The edit form time format string.
-
-
-
- Gets or sets the maximum height of the modal advanced form.
-
- The maximum height of the modal advanced form.
-
-
-
- Gets or sets the width of the modal advanced form.
-
- The width of the modal advanced form
-
-
-
- Gets or sets a value indicating whether to use the integrated context menu.
-
- true if the intergrated menu is enabled; otherwise, false.
-
-
- Gets or sets the skin name for the context menu.
- A string indicating the skin name for the context menu. The default is "Default".
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
-
- Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
-
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
-
- Gets the recurrence exception appointment that is about to be created.
-
- The recurrence exception appointment that is about to be created.
-
-
-
- Gets the master appointment to which the recurrence exception is about to be attached.
-
- The master appointment to which the recurrence exception is about to be attached.
-
-
-
- Gets the occurrence appointment that is about to be overriden by the recurrence exception.
-
- The occurrence appointment that is about to be overriden by the recurrence exception.
-
-
-
- The date of the recurrence exception that is being created by
- the current Insert / Update operation pair.
-
-
-
-
- A reference to the original appointment during an Update operation.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
- Represents settings for RadScheduler's multi-day view.
-
-
- Represents settings for RadScheduler's week view.
-
-
-
- Gets or sets a value indicating whether the view is in read-only mode.
-
-
- true if view should be read-only; false otherwise. The default value is false.
-
-
- By default the user is able to insert, edit and delete appointments. Use the ReadOnly to disable the editing capabilities of RadScheduler.
-
-
-
-
- Gets or sets a value indicating whether to render date headers for the current view.
-
- true if the date headers for the current view are rendered; otherwise, false.
-
-
-
- Gets or sets a value indicating whether to render a tab for the current view in the view chooser.
-
- true if a tab for the current view in the view chooser is rendered; otherwise, false.
-
-
-
- Gets or sets the resource to group by.
-
- The resource to group by.
-
-
-
- Gets or sets the resource grouping direction.
-
-
-
-
- Gets or sets a value indicating whether to render resource headers for the current view.
-
- true if the resource headers for the current view are rendered; otherwise, false.
-
-
-
- Gets or sets the time used to denote the start of the day.
-
-
- The time used to denote the start of the day.
-
-
-
-
- Gets or sets the time used to denote the end of the day.
-
-
- The time used to denote the end of the day.
-
-
-
-
- Gets or sets the time used to denote the start of the work day.
-
-
- The time used to denote the start of the work day.
-
-
- The effect from this property is only visual.
-
-
-
-
- Gets or sets the time used to denote the end of the work day.
-
-
- The time used to denote the end of the work day.
-
-
- The effect from this property is only visual.
-
-
-
-
- Gets or sets a value indicating whether to render the hours column in day and week view.
-
- true if the hours column is rendered in day and week view; otherwise, false.
-
-
-
-
-
-
-
- Gets or sets the week header date format string.
-
- The week header date format string.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets the week column header date format string.
-
- The week column header date format string.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
-
-
-
-
- Gets or sets the mult-day header date format string.
-
- The multi-day header date format string.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets the multi-day header column date format string.
-
- The multi-day column header date format string.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets a value indicating whether to render a tab for the current view in the view chooser.
-
- true if a tab for the current view in the view chooser is rendered; otherwise, false.
-
-
- Represents settings for RadScheduler's day view.
-
-
-
-
-
-
-
- Gets or sets the day header date format string.
-
- The day header date format string.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Not applicable in day view.
-
-
-
- Represents settings for RadScheduler's Month view.
-
-
-
-
-
-
-
- Gets or sets the RadScheduler's header date format string in Month View.
-
- The RadScheduler's header date format string in Month View.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets the column header date format string in Month View.
-
- The column header date format string in Month View.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets the day header date format string in Month View.
-
- The day header date format string in Month View.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets the first day of month header date format in Month View.
-
- The first day of month header date format in Month View.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets a value indicating the number of visible appointments per day in month view.
-
-
- A number specifying the number of visible appointments per day. The default value is 2.
-
-
- A link button navigating to the specific date will be rendered when
- the number of appointments exceeds this value.
-
-
-
-
- Gets or sets a value indicating whether the height of each row
- should be adjusted to match the height of its content.
-
-
- true if the height of each row should be adjusted to match the height of its content;
- false if all rows should be with the same height.
- The default value is false.
-
-
- By default, all rows are rendered with the same height.
- This property allows you to change this behaviour.
-
-
-
-
- Gets or sets a value indicating the minimum row height in month view.
-
-
- A number specifying the the minimum row height. The default value is 4.
-
-
- This property is ignored when AdaptiveRowHeight
- is set to true.
-
-
-
-
- Specifies resource grouping direction in RadScheduler.
-
-
-
- Represents settings for the time line view.
-
-
-
-
-
-
-
- The starting time of the Timeline view.
-
-
-
-
- The number of slots to display in timeline view.
-
-
-
-
- The duration of each slot in timeline view.
-
-
-
-
- Gets or sets the Timeline view header date format string.
-
- The Timeline view header date format string.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets the timeline column header date format string.
-
- The timeline column header date format string.
-
- For additional information, please read this
- MSDN article.
-
-
-
-
- Gets or sets the number of rows/columns each time label spans.
-
-
- The number of rows/columns each time label spans.
- The default value is 1
-
-
-
-
- Gets or sets a boolean value that specifies whether to
- show an empty area at the end of each time slot that can
- be used to insert appointments.
-
-
- true, insert are should be shown; false otherwise.
- The default value is true
-
-
-
- The insert area is not visible if the scheduler is in read-only mode or
- AllowInsert is false.
-
-
- If all time slots are full and this property is set to false,
- the user will not be able to insert appointments.
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Creates default recurrence rule for newly created recurring appointments.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Synchronize the height of all cells in the table.
-
-
-
-
- Adds padding to the table cells, so they are at least hight.
-
-
-
-
- Sycnhronize the height of the cells in the specified row.
-
-
-
-
- Synchronizes the row heights of two tables with identical dimensions.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- A list of the appointments that start in this time slot.
-
-
-
-
- The control that represents this time slot.
-
-
-
-
- The start time of the time slot.
-
-
-
-
- The end time of the time slot.
-
-
-
-
- The duration of the time slot.
-
-
-
-
- The unique index of the time slot.
-
-
-
-
-
-
-
-
- An optional CSS class name that will be rendered for the time slot.
-
-
-
-
- The resource associated with the time slot.
-
- The resource associated with the time slot in grouped views, otherwise null.
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Defines the output compression mode of the Telerik.Web.UI.WebResource.axd handler.
-
-
-
-
- The compression is disabled (raw content is output to the browser).
-
-
-
-
- Compression is identified by the browser and its version.
-
-
-
-
- Output is always compressed.
-
-
-
-
- Specialized class for the RadSiteMap.DefaultLevelSettings.
- Removes the Level property from the property grid and IntelliSense.
-
-
-
-
- Gets or sets the level to which a given LevelSetting refer/
-
-
- The Level property serves for explicitly setting the level to which a given
- LevelSetting refer.
-
-
-
-
- Gets or sets the layout mode that is applied to a given LevelSetting. By default is set to List
-
-
-
- levelSetting.LayoutMode = SiteMapLayout.List;
- levelSetting.LayoutMode = SiteMapLayout.Flow;
-
-
- levelSetting.LayoutMode = SiteMapLayout.List
- levelSetting.LayoutMode = SiteMapLayout.Flow
-
-
-
-
-
- Gets or sets the maximum nodes that are allowed for a given level.
-
-
- Use the MaximumNodes property to explicitly state how many nodes should be rendered
- for a given level.
-
- Redundant nodes are sliced. If MaximumNodes is set to a value larger
- than the nodes count, all of the nodes will be rendered.
-
-
-
-
-
- Gets or sets the width of the specified level.
-
-
- A Unit specifying width of the specified level. The
- default value is Unit.Empty.
-
-
-
-
- Gets or sets the separator text that is going to be used to separate
- nodes in Flow layout mode.
-
-
- A string value that is used to separate nodes when the LevelSetting layout mode is set to Flow.
-
-
-
-
- Gets or sets the URL to an image which is displayed next to all the nodes of a given level
-
-
- The URL to the image to display for all the nodes of a given level. The default value is empty
- string which means by default no image is displayed.
-
-
- Use the ImageUrl property to specify a custom image that will be
- displayed before the text of the current node.
-
-
-
- Gets or sets the template for displaying the nodes on the specified level.
-
-
- An object implementing the ITemplate interface. The default value is a null reference
- (Nothing in Visual Basic), which indicates that this property is not set.
-
-
- To specify template for a single node use the property of
- the control.
-
-
-
- The following template demonstrates how to add an Image control in certain
- node.
- ASPX:
-
- <telerik: RadSiteMap runat="server" ID="RadSiteMap1">
- <DefaultLevelSettings>
- <NodeTemplate>
- <asp:Image ID="Image1" runat="server" ImageUrl="MyImage.gif"></asp:Image>
- </NodeTemplate>
- </DefaultLevelSettings>
- </telerik:RadSiteMap>
-
-
-
-
- Gets or sets the separator template for nodes on the specified level.
-
-
- An object implementing the ITemplate interface. The default value is a null reference
- (Nothing in Visual Basic), which indicates that this property is not set.
-
-
- To specify separator template for a single node use the property of
- the control.
-
-
- The separator is rendered only in Flow mode.
-
-
-
- The following template demonstrates how to add custom separator to a certain node.
- ASPX:
-
- <telerik: RadSiteMap runat="server" ID="RadSiteMap1">
- <DefaultLevelSettings>
- <SeparatorTemplate>
- <asp:Image ID="Image1" runat="server" ImageUrl="MySeparator.gif"></asp:Image>
- </SeparatorTemplate>
- </DefaultLevelSettings>
- </telerik:RadSiteMap>
-
-
-
-
-
- Not applicable to DefaultSiteMapLevelSetting
-
-
-
-
- Specifies the layout mode of RadSiteMap nodes.
-
-
-
-
- Nodes are rendered as a list in one or more columns.
-
-
-
-
- Nodes are rendered horizontally to fill the available width. Nodes automatically wrap.
-
-
-
-
- Specifies the repeat direction of RadSiteMap columns.
-
-
-
-
- Nodes are displayed vertically in columns from top to bottom,
- and then left to right, until all nodes are rendered.
-
-
-
-
- Nodes are displayed horizontally in rows from left to right,
- then top to bottom, until all nodes are rendered.
-
-
-
-
- Defines properties that node containers (RadSiteMap,
- RadSiteMapNode) should implement.
-
-
-
- Gets the parent IRadSiteMapNodeContainer.
-
-
- Gets the collection of child items.
-
- A RadSiteMapNodeCollection that represents the child
- items.
-
-
- Use this property to retrieve the child items. You can also use it to
- programmatically add or remove items.
-
-
-
- Represents a node in the RadSiteMap control.
-
-
- The RadSiteMap control is made up of nodes. Nodes which are immediate children
- of the control are root nodes. Nodes which are children of other nodes are child nodes.
-
-
- A node usually stores data in two properties, the Text property and
- the NavigateUrl property.
-
- To create nodes, use one of the following methods:
-
-
- Data bind the RadSiteMap control to a data source,
- for example SiteMapDataSource.
-
-
- Use declarative syntax to define nodes inline in your page or user control.
-
-
- Use one of the constructors to dynamically create new instances of the
- RadSiteMap class. These nodes can then be added to the
- Nodes collection of another node or site map.
-
-
-
- When the user clicks a node, the RadSiteMap control navigates
- to the linked Web page. By default, a linked page
- is displayed in the same window or frame. To display the linked content in a different
- window or frame, use the Target property.
-
-
-
-
- Initializes a new instance of the RadSiteMapNode class.
-
- Use this constructor to create and initialize a new instance of the
- RadSiteMapNode class using default values.
-
-
- The following example demonstrates how to add node to
- RadSiteMap controls.
-
- RadSiteMapNode node = new RadSiteMapNode();
- node.Text = "News";
- node.NavigateUrl = "~/News.aspx";
-
- RadSiteMap1.Nodes.Add(node);
-
-
- Dim node As New RadSiteMapNode()
- node.Text = "News"
- node.NavigateUrl = "~/News.aspx"
-
- RadSiteMap1.Nodes.Add(node)
-
-
-
-
-
- Initializes a new instance of the RadSiteMapNode class with the
- specified text, value and URL.
-
-
- Use this constructor to create and initialize a new instance of the
- RadSiteMapNode class using the specified text, value and URL.
-
-
- This example demonstrates how to add nodes to RadSiteMap
- control.
-
- RadSiteMapNode node = new RadSiteMapNode("News", "~/News.aspx");
-
- RadSiteMap1.Nodes.Add(node);
-
-
- Dim node As New RadSiteMapNode("News", "~/News.aspx")
-
- RadSiteMap1.Nodes.Add(node)
-
-
-
- The text of the node. The Text property is set to the value
- of this parameter.
-
-
- The url which the node will navigate to. The
- NavigateUrl property is set to the value of this
- parameter.
-
-
-
-
- Removes the node from the Nodes collection of its parent
-
-
- The following example demonstrates how to remove a node.
-
- RadSiteMapNode node = RadSiteMap1.Nodes[0];
- node.Remove();
-
-
- Dim node As RadSiteMapNode = RadSiteMap1.Nodes(0)
- node.Remove()
-
-
-
-
-
- Gets or sets the text displayed for the current node.
-
-
- The text displayed for the node in the RadSiteMap control. The default is empty string.
-
-
- Use the Text property to specify or determine the text that is displayed for the node
- in the RadSiteMap control.
-
-
-
-
- Gets or sets the URL to navigate to when the current node is clicked.
-
-
- The URL to navigate to when the node is clicked. The default value is empty string which means that
- clicking the current node will not navigate.
-
-
-
-
- Gets or sets the target window or frame in which to display the Web page content associated with the current node.
-
-
- The target window or frame to load the Web page linked to when the node is
- clicked. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without frames.
-
-
- _parent
- Renders the content in the immediate frameset parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without frames.
-
-
-
- The default value is empty string which means the linked resource will be loaded in the current window.
-
-
-
- Use the Target property to target window or frame in which to display the
- Web page content associated with the current node. The Web page is specified by
- the NavigateUrl property.
-
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
- The Target property is taken into consideration only when the NavigateUrl
- property is set.
-
-
-
- The following example demonstrates how to use the Target property
-
-
- <telerik:RadSiteMap id="RadSiteMap1" runat="server">
- <Nodes>
- <telerik:RadSiteMapNode Text="News" NavigateUrl="~/News.aspx"
- Target="_self" />
- <telerik:RadSiteMapNode Text="External URL" NavigateUrl="http://www.example.com"
- Target="_blank" />
- </Nodes>
- </telerik:RadSiteMap>
-
-
-
-
-
- Gets or sets custom (user-defined) data associated with the current node.
-
-
- A string representing the user-defined data. The default value is emptry string.
-
-
- Use the Value property to associate custom data with a RadSiteMap object.
-
-
-
-
- Gets or sets the tooltip shown for the node when the user hovers it with the mouse
-
-
- A string representing the tooltip. The default value is empty string.
-
-
- The ToolTip property is also used as the alt attribute of the node image (in case is set)
-
-
-
-
- Gets or sets a value indicating whether the node is enabled.
-
-
- true if the node is enabled; otherwise false. The default value is true.
-
-
- Disabled nodes cannot be clicked, or expanded.
-
-
-
- Gets the data item that is bound to the node
-
- An Object that represents the data item that is bound to the node. The default value is null (Nothing in Visual Basic),
- which indicates that the node is not bound to any data item. The return value will always be null unless accessed within
- a NodeDataBound event handler.
-
-
- This property is applicable only during data binding. Use it along with the
- NodeDataBound event to perform additional
- mapping of fields from the data item to RadSiteMapNode properties.
-
-
- The following example demonstrates how to map fields from the data item to
- RadSiteMapNode properties. It assumes the user has subscribed to the
- NodeDataBound event.
-
- private void RadSiteMap1_NodeDataBound(object sender, Telerik.Web.UI.RadSiteMapNodeEventArgs e)
- {
- e.Node.ImageUrl = "image" + (string)DataBinder.Eval(e.Node.DataItem, "ID") + ".gif";
- e.Node.NavigateUrl = (string)DataBinder.Eval(e.Node.DataItem, "URL");
- }
-
-
- Sub RadSiteMap1_NodeDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadSiteMapNodeEventArgs ) Handles RadSiteMap1.NodeDataBound
- e.Node.ImageUrl = "image" & DataBinder.Eval(e.Node.DataItem, "ID") & ".gif"
- e.Node.NavigateUrl = CStr(DataBinder.Eval(e.Node.DataItem, "URL"))
- End Sub
-
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied by default to the node.
-
-
- By default the visual appearance of hovered nodes is defined in the skin CSS
- file. You can use the CssClass property to specify unique
- appearance for the node.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied to the node when the mouse hovers it.
-
-
- By default the visual appearance of hovered nodes is defined in the skin CSS
- file. You can use the HoveredCssClass property to specify unique
- appearance for a node when it is hoevered.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied to the node when it is disabled.
-
-
- By default the visual appearance of disabled nodes is defined in the skin CSS
- file. You can use the DisabledCssClass property to specify unique
- appearance for a node when it is disabled.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when node is
- selected.
-
-
- By default the visual appearance of selected nodes is defined in the skin CSS
- file. You can use the SelectedCssClass property to specify unique
- appearance for a node when it is selected.
-
-
-
-
- Gets or sets the URL to an image which is displayed next to the text of a node.
-
-
- The URL to the image to display for the node. The default value is empty
- string which means by default no image is displayed.
-
-
- Use the ImageUrl property to specify a custom image that will be
- displayed before the text of the current node.
-
-
-
- The following example demonstrates how to specify the image to display for
- the node using the ImageUrl property.
-
-
- <telerik:RadSiteMap id="RadSiteMap1" runat="server">
- <Nodes>
- <telerik:RadSiteMapNodeImageUrl="~/Img/inbox.gif"
- Text="Index"></telerik:RadSiteMapNode>
- <telerik:RadSiteMapNodeImageUrl="~/Img/outbox.gif"
- Text="Outbox"></telerik:RadSiteMapNode>
- <telerik:RadSiteMapNodeImageUrl="~/Img/trash.gif"
- Text="Trash"></telerik:RadSiteMapNode>
- <telerik:RadSiteMapNodeImageUrl="~/Img/meetings.gif"
- Text="Meetings"></telerik:RadSiteMapNode>
- </Nodes>
- </telerik:RadSiteMap>
-
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is hovered with the mouse.
-
-
- If the HoveredImageUrl property is not set the ImageUrl property will be
- used when the node is hovered.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is disabled.
-
-
- If the DisabledImageUrl property is not set the ImageUrl property will be
- used when the node is disabled.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is selected.
-
-
- If the SelectedImageUrl property is not set the ImageUrl property will be
- used when the node is selected.
-
-
-
-
- Gets the level of the node.
-
-
- An integer representing the level of the node. Root nodes are level 0 (zero).
-
-
-
-
- Gets a object that contains the child nodes of the current RadSiteMapNode.
-
-
- A that contains the child nodes of the current RadSiteMapNode. By default
- the collection is empty (the node has no children).
-
-
- Use the Nodes property to access the child nodes of the RadSiteMapNode. You can also use the Nodes property to
- manage the child nodes - you can add, remove or modify nodes.
-
-
- The following example demonstrates how to programmatically modify the properties of a child node.
-
- RadSiteMapNode node = RadSiteMap1.FindNodeByText("Test");
- node.Nodes[0].Text = "Example";
- node.Nodes[0].NavigateUrl = "http://www.example.com";
-
-
- Dim node As RadSiteMapNode = RadSiteMap1.FindNodeByText("Test")
- node.Nodes(0).Text = "Example"
- node.Nodes(0).NavigateUrl = "http://www.example.com"
-
-
-
-
-
- Gets the which this node belongs to.
-
-
- The which this node belongs to;
- null (Nothing) if the node is not added to any control.
-
-
-
-
- Gets or sets a value indicating whether the node is selected.
-
-
- True if the node is selected; otherwise false. The default value is
- false.
-
-
- Only one node can be selected.
-
-
-
- Gets or sets the template for displaying the node.
-
-
- An object implementing the ITemplate interface. The default value is a null reference
- (Nothing in Visual Basic), which indicates that this property is not set.
-
-
- To specify common display for all nodes use the
- RadSiteMap.DefaultLevelSettings.NodeTemplate property.
-
-
-
- The following template demonstrates how to add an Image control in certain
- node.
- ASPX:
-
- <telerik: RadSiteMap runat="server" ID="RadSiteMap1">
- <Nodes>
- <telerik:RadSiteMapNode Text="Root Node" >
- <Nodes>
- <telerik:RadSiteMapNode>
- <NodeTemplate>
- <asp:Image ID="Image1" runat="server" ImageUrl="MyImage.gif"></asp:Image>
- </NodeTemplate>
- </telerik:RadSiteMapNode>
- </Nodes>
- </telerik:RadSiteMapNode>
- </Nodes>
- </telerik:RadSiteMap>
-
-
-
-
- Gets or sets the separator template for the node.
-
-
- An object implementing the ITemplate interface. The default value is a null reference
- (Nothing in Visual Basic), which indicates that this property is not set.
-
-
- To specify common display for all nodes use the
- RadSiteMap.DefaultLevelSettings.SeparatorTemplate property.
-
-
- The separator is rendered only in Flow mode.
-
-
-
- The following template demonstrates how to add custom separator to a certain node.
- ASPX:
-
- <telerik: RadSiteMap runat="server" ID="RadSiteMap1">
- <Nodes>
- <telerik:RadSiteMapNode Text="Root Node" >
- <Nodes>
- <telerik:RadSiteMapNode>
- <SeparatorTemplate>
- <asp:Image ID="Image1" runat="server" ImageUrl="MySeparator.gif"></asp:Image>
- </SeparatorTemplate>
- </telerik:RadSiteMapNode>
- </Nodes>
- </telerik:RadSiteMapNode>
- </Nodes>
- </telerik:RadSiteMap>
-
-
-
-
-
- Gets the parent node of the current node.
-
-
- The parent node. If the the node is a root node null (Nothing) is returned.
-
-
-
-
- Represents the method that handles the and events.
- of the control.
-
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- Raises the event.
-
- The instance containing the event data.
-
-
-
- This methods clears the selected nodes of the current RadSiteMap instance.
-
-
-
-
- Gets a linear list of all nodes in the RadSiteMap control.
-
- An IList<RadSiteMapNode> containing all nodes (from all hierarchy levels).
-
-
-
- Gets a object that contains the root nodes of the current RadSiteMap control.
-
-
- A that contains the root nodes of the current RadSiteMap control. By default
- the collection is empty (RadSiteMap has no children).
-
-
- Use the nodes property to access the root nodes of the RadSiteMap control. You can also use the nodes property to
- manage the root nodes - you can add, remove or modify nodes.
-
-
- The following example demonstrates how to programmatically modify the properties of a root node.
-
- RadSiteMap1.Nodes[0].Text = "Example";
- RadSiteMap1.Nodes[0].NavigateUrl = "http://www.example.com";
-
-
- RadSiteMap1.Nodes(0).Text = "Example"
- RadSiteMap1.Nodes(0).NavigateUrl = "http://www.example.com"
-
-
-
-
-
- Gets a collection of RadSiteMapNode objects that represent the node in the control
- that is currently selected.
-
-
-
-
- Gets or sets the SiteMapLevelSetting
- object to be used when no specific settings have been defined for a given level.
-
-
- A SiteMapLevelSetting object.
-
-
- Individual levels can be customized using the LevelSettings
- collection. Levels not specified in this collection will get the default settings.
-
-
-
-
- Gets the collection of LevelSettings objects that
- define the appearance of the nodes according to their level in the hierarchy.
-
-
- A SiteMapLevelSettingCollection
- containing LevelSettings that define the
- appearance of the nodes according to their level in the hierarchy.
-
-
-
-
- Gets or sets a value indicating whether to render node lines in a fashion similar to RadTreeView.
-
-
- Node lines are supported in List rendering mode without columns.
-
-
- true if node lines should be rendered;
- false otherwise.
- The default value is false
-
-
-
-
- Gets a collection of objects that define the relationship
- between a data item and the tree node it is binding to.
-
-
- A that represents the relationship between a data item and the tree node it is binding to.
-
-
-
-
- Occurs when node is data bound.
-
-
- Use the NodeDataBound event to set additional properties of the databound nodes.
-
-
-
- protected void RadSiteMap1_NodeDataBound(object sender, RadSiteMapNodeEventArgs e)
- {
- e.Node.ToolTip = (string)DataBinder.Eval(e.Node.DataItem, "ToolTipColumn");
- }
-
-
- Protected Sub RadSiteMap1_NodeDataBound(sender As Object, e As RadSiteMapNodeEventArgs)
- e.Node.ToolTip = DirectCast(DataBinder.Eval(e.Node.DataItem, "ToolTipColumn"), String)
- End Sub
-
-
-
-
-
- Occurs when node is created.
-
-
- The NodeCreated event occurs before and after postback if ViewState is enabled.
- NodeCreated is not raised for items defined inline in the ASPX.
-
-
-
-
- Provides data for the , events of the
- control.
-
-
-
-
- Initializes a new instance of the class.
-
- The referenced node.
-
-
-
- Gets or sets the referenced node in the control when the event is raised.
-
- The referenced node in the control when the event is raised.
-
-
-
- Defines the relationship between a data item and the RadSiteMap node it is binding to in a
- RadSiteMapcontrol.
-
-
-
-
- Gets the object at the specified index in
- the current .
-
-
- The zero-based index of the to retrieve.
-
-
- The at the specified index in the
- current .
-
-
-
-
- Represents a collection of objects in a control.
-
-
-
-
- Initializes a new instance of the class.
-
- The parent control.
-
-
-
- Appends a node to the collection.
-
- The node to add to the collection.
-
-
- Appends the specified array of objects to the end of the
- current .
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple nodes in a single step.
-
- RadSiteMapNode[] nodes = new RadSiteMapNode[] { new RadSiteMapNode("First"), new RadSiteMapNode("Second"), new RadSiteMapNode("Third") };
- RadSiteMap1.Nodes.AddRange(nodes);
-
-
- Dim nodes() As RadSiteMapNode = {New RadSiteMapNode("First"), New RadSiteMapNode("Second"), New RadSiteMapNode("Third")}
- RadSiteMap1.Nodes.AddRange(nodes)
-
-
-
- The array of to append to the end of the current
- .
-
-
-
-
- Inserts a node to the collection at the specified index.
-
- The zero-based index at which should be inserted.
- The node to insert into the collection.
-
-
-
- Removes the specified node from the collection.
-
- The node to remove from the collection.
-
-
-
- Searches all nodes for a RadSiteMapNode with a Text property
- equal to the specified text.
-
- The text to search for
- A RadSiteMapNode whose Text property equals to the specified argument.
- Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
-
-
-
- Searches all nodes for a RadSiteMapNode with a Text property
- equal to the specified text.
-
- The text to search for
- A RadSiteMapNode whose Text property equals to the specified argument
- Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the first RadSiteMapNode
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindNode method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadSiteMap1.FindNode(NodeWithEqualsTextAndValue);
- }
- private static bool NodeWithEqualsTextAndValue(RadSiteMapNode node)
- {
- if (node.Text == node.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadSiteMap1.FindNode(NodeWithEqualsTextAndValue)
- End Sub
- Private Shared Function NodeWithEqualsTextAndValue(ByVal node As RadSiteMapNode) As Boolean
- If node.Text = node.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <RadSiteMapNode> that defines the conditions of the element to search for.
-
-
-
- Represents a collection of objects in a control.
-
-
-
-
- Represents a collection of objects in a control.
-
-
-
-
- Gets or sets the at the specified index.
-
-
-
-
- Represents the simple binding between the property value of an object and the property value of a
- RadSiteMapNode.
-
-
-
-
- Specifies the exact value of the DisabledCssClass property of the
- RadSiteMapNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledCssClass property
- value of the RadSiteMapNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledImageUrl property of the
- RadSiteMapNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledImageUrl property
- value of the RadSiteMapNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the HoveredCssClass property of the
- RadSiteMapNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the HoveredCssClass property
- value of the RadSiteMapNode that will be created during
- the data binding.
-
-
-
-
- Gets or sets the number of columns to display on this level.
-
-
- Specifies the number of columns which are displayed for a given level. For example,
- if it set to 3, the nodes in the level are displayed in three columns.
-
-
-
-
- Gets or sets whether the columns are repeated vertically or horizontally
-
-
- When this property is set to Vertical,
- nodes are displayed vertically in columns from top to bottom,
- and then left to right, until all nodes are rendered.
-
-
- When this property is set to Horizontal,
- nodes are displayed horizontally in rows from left to right,
- then top to bottom, until all nodes are rendered.
-
-
-
-
-
- Gets or sets a value indicating whether Skin chooser should be rendered in run-time.
-
-
-
-
- Gets or sets a value indicating whether skinning should be enabled or not.
-
-
-
-
- "Specifies the skin that will be used by the control"
-
-
-
-
- Specifies the skin manager persistance mode.
-
-
-
-
- Gets a collection of TargetControl objects that allows for specifying the objects for which tooltips will be created on the client-side.
-
-
- Gets a collection of TargetControl objects that allows for specifying the objects for which tooltips will be created on the client-side.
-
-
- Use the TargetControls collection to programmatically control which objects should be tooltipified on the client-side.
-
-
-
-
- Gets or sets a value indicating whether skinning should be enabled or not.
-
-
-
-
- RadSliderItem class.
-
-
-
- Gets or sets the text caption for the slider item.
- The text of the item. The default value is empty string.
-
- Use the Text property to specify the text to display for the
- item.
-
-
-
- Gets or sets the value for the slider item.
- The value of the item. The default value is empty string.
-
- Use the Value property to specify the value
-
-
-
-
- Gets the RadSlider instance which contains the current item.
-
-
-
-
- Gets the RadSlider instance which contains the current item.
-
-
-
- Gets the selected state of the slider item.
-
- Use the Selected property to determine whether the item is selected or not.
-
-
-
- Gets or sets the tooltip of the slider item.
-
-
-
- A collection of RadSliderItem objects in a
- RadSlider control.
-
-
- The RadSliderItemCollection class represents a collection of
- RadSliderItem objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadSliderItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of slider items in the collection.
-
-
- Use the Add method to add items in the collection.
-
-
- Use the Remove method to remove items from the
- collection.
-
-
-
-
-
-
-
- Initializes a new instance of the RadSliderItemCollection class.
-
- The owner of the collection.
-
-
-
- Appends the specified RadSliderItem object to the end of the current RadSliderItemCollection.
-
-
- The RadSliderItem to append to the end of the current RadSliderItemCollection.
-
-
-
-
- Finds the first RadSliderItem with Text that
- matches the given text value.
-
-
- The first RadSliderItem that matches the
- specified text value.
-
- The string to search for.
-
-
-
- Finds the first RadSliderItem with Value that
- matches the given value.
-
-
- The first RadSliderItem that matches the
- specified value.
-
- The value to search for.
-
-
-
- Searches the items in the collection for a RadSliderItem which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadSliderItem that matches the specified arguments. Null (Nothing) is returned if no node is found.
-
-
-
- Determines whether the specified RadSliderItem object is in the current
- RadSliderItemCollection.
-
-
- The RadSliderItem object to find.
-
-
- true if the current collection contains the specified RadSliderItem object;
- otherwise, false.
-
-
-
- Appends the specified array of RadSliderItem objects to the end of the
- current RadSliderItemCollection.
-
-
- The array of RadSliderItem to append to the end of the current
- RadSliderItemCollection.
-
-
-
-
- Determines the index of the specified RadSliderItem object in the collection.
-
-
- The RadSliderItem to locate.
-
-
- The zero-based index of item within the current RadSliderItemCollection,
- if found; otherwise, -1.
-
-
-
-
- Inserts the specified RadSliderItem object in the current
- RadSliderItemCollection at the specified index location.
-
- The zero-based index location at which to insert the RadSliderItem.
- The RadSliderItem to insert.
-
-
-
- Removes the specified RadSliderItem object from the current
- RadSliderItemCollection.
-
-
- The RadSliderItem object to remove.
-
-
-
-
- Removes the specified RadSliderItem object from the current
- RadSliderItemCollection.
-
-
- The zero-based index of the index to remove.
-
-
-
-
- Gets the RadSliderItem object at the specified index in
- the current RadSliderItemCollection.
-
-
- The zero-based index of the RadSliderItem to retrieve.
-
-
- The RadSliderItem at the specified index in the
- current RadSliderItemCollection.
-
-
-
-
- Telerik RadSpell
-
-
-
-
-
-
-
-
- Gets the value that corresponds to this Web server control. This property is used primarily by control developers.
-
-
- One of the enumeration values.
-
-
-
- Gets or sets the URL for the spell dialog handler
-
- the relative path for the spell dialog handler
-
-
-
- Gets or sets the location of a CSS file, that will be added in the dialog window. If you need to include
- more than one file, use the CSS @import url(); rule to add the other files from the first.
- This property is needed if you are using a custom skin. It allows you to include your custom skin
- CSS in the dialogs, which are separate from the main page.
-
-
-
-
- Gets or sets the location of a JavaScript file, that will be added in the dialog window. If you need to include
- more than one file, you will need to combine the scripts into one first.
- This property is needed if want to override some of the default functionality without loading the dialog
- from an external ascx file.
-
-
-
-
- Gets or sets an additional querystring appended to the dialog URL.
-
- A String, appended to the dialog URL
-
-
- Gets or sets the value indicating whether the spell will allow adding custom words.
- The default is true
-
-
-
- Gets or sets the URL which the AJAX call will be made to. Check the help for more information.
-
-
-
- Gets or sets the text of the button that will start the spellcheck. This property is localizable.
- The default is Spell Check
-
-
- Gets or sets the type of the button that will start the spellcheck.
- The default is PushButton
-
- Values allowed:
- PushButton/LinkButton/ImageButton/
- None.
- Setting the value to None will not render a button. The only
- way to start a spellcheck will be through the client-side API.
-
-
-
- Gets or sets the class of the client side text source object.
-
- A string containing the name of the JavaScript class. The
- default is HtmlElementTextSource -- a built in implementation that obtains the
- source from a HTML element.
-
-
- The text source is a JavaScript object. It has to provide two methods: GetText() and SetText(newValue).
-
-
-
- <script type="text/javascript">
- function DifferentControlsSource()
- {
- this.GetText = function()
- {
- return document.getElementById('before').value;
- }
-
- this.SetText = function(newValue)
- {
- document.getElementById('after').value = newValue;
- }
- }
- </script>
-
-
-
-
-
- The ID of the control to check.
-
-
- The ID can be both a server-side ID, or a client-side ID. RadSpell will find the
- appropriate server control and use its ClientID to attach to it.
-
-
-
-
- An array of IDs of the control to check.
-
-
- The IDs can be server-side or client-side. RadSpell will find the
- appropriate server control and use its ClientID to attach to it.
- Note that you cannot mix server and client IDs in this list - use only one kind.
-
-
-
-
- Gets or sets the fully qualified type name that will be used to store and read
- the custom dictionary.
-
-
- The type name must be fully qualified if the type is in a GAC-deployed assembly.
- The type must implement the
- ICustomDictionarySource
- interface.
-
-
-
- spell1.CustomDictionarySourceTypeName = "RadSpellExtensions.CustomDictionarySource, RadSpellExtensions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b5e57ccb698eab8e";
-
-
- spell1.CustomDictionarySourceTypeName = "RadSpellExtensions.CustomDictionarySource, RadSpellExtensions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b5e57ccb698eab8e"
-
-
-
-
- Gets or sets the suffix for the custom dictionary files.
- The default is -Custom
-
- The filenames are formed with the following scheme: Language + CustomDictionarySuffix +
- ".txt". Different suffixes can be used to create different custom dictionaries for
- different users.
-
-
-
- Gets or sets the assembly qualified name of the SpellDialog type.
- The default is string.Empty
-
-
- Gets or sets the virtual path of the UserControl that represents the SpellDialog.
- The default is string.Empty
-
-
- Gets or sets the dictionary language used for spellchecking.
- The default is en-US
-
- The language name is used to find a corresponding dictionary file. Spellchecking in
- en-US will work only if a file en-US.TDF can be found inside the folder pointed to
- by DictionaryPath.
-
-
-
- Gets or sets the path for the dictionary files.
- The default is ~/RadControls/Spell/TDF/
-
- This is the path that contains the TDF files, and the custom dictionary TXT
- files.
-
-
-
-
- Gets or sets a the edit distance. If you increase the value, the checking speed
- decreases but more suggestions are presented. Applicable only in EditDistance mode.
-
- The default is 1
-
- This property takes effect only if the
- SpellCheckProvider property is set to
- EditDistanceProvider.
-
-
-
-
- Configures the spellchecker engine, so that it knows whether to skip URL's, email
- addresses, and filenames and not flag them as erros.
-
-
-
-
- Gets or sets a value indicating whether whether the ControlToCheck
- property provides a client element ID or a server side control ID.
-
- The default is false.
-
- When true RadSpell will look for the server-side control and get
- its ClientID. When false the
- ControlToCheck property will be interpreted as a
- client-side ID and will be used to attach to the target control.
-
-
-
- Gets or sets the localization language for the user interface.
-
- The localization language for the user interface. The default value is
- en-US.
-
-
-
-
- Gets a value indicating if the target control has been spellchecked.
-
-
- Spellchecking the entire text by the client would set the property to
- true on postback.
-
- The property is used by the SpellCheckValidator class. You can set it on the
- client side with RadSpell's SetSpellChecked(false) on various events, say a
- TEXTAREA's OnChange.
-
-
-
- Allows the use of a custom spell checking provider. It must implement the ISpellCheckProvider interface.
- The default is PhoneticProvider
-
-
- Specifies the spellchecking algorithm which will be used by RadSpell.
- The default is PhoneticProvider
-
-
- Gets or sets the supported languages.
-
- The supported languages will be displayed in a drop-down list, and the user can
- select the language for spellchecking.
-
-
- A string array containing the codes and names of the languages (code, name, code,
- name...)
-
-
-
- <radS:RadSpell ID="spell1"
- Runat="server"
- ControlToCheck="textBox1"
- SupportedLanguages="en-US,English,fr-FR,French">
- </radS:RadSpell>
-
-
-
-
-
- Gets or sets the value used to configure the spellchecker engine to ignore words containing: UPPERCASE, some
- CaPitaL letters, numbers; or to ignore repeated words (very very)
-
-
-
-
- Gets or sets the name of the client-side function that will be called when the
- spell control is initialized on the page.
-
-
- The function should accept two parameters: sender (the spell client object) and arguments.
-
-
-
- function onSpellLoad(sender, args)
- {
- log("spell: " + sender.get_id() + " ready.");
- }
-
-
-
-
-
- Gets or sets the name of the client-side function that will be called when the
- spell check starts.
-
-
- The function should accept two parameters: sender (the spell client object) and arguments.
-
-
-
- function onCheckStarted(sender, args)
- {
- log("spell: " + sender.clientId + " started for: " + sender.targetControlId);
- }
-
-
-
-
-
- Gets or sets the name of the client-side function that will be called when the
- spell check is finished.
-
-
- The function should accept two parameters: sender (the spell client object) and arguments.
-
-
-
- function onCheckFinished(sender, args)
- {
- log("spell: " + sender.clientId + " finished for: " + sender.targetControlId);
- }
-
-
-
-
-
- Specifies the name of the client-side function that will be called when the user
- cancels the spell check.
-
-
- The function should accept two parameters: sender (the spell client object) and arguments.
-
-
-
- function onCheckCancelled(sender, args)
- {
- log("spell: " + sender.clientId + " cancelled for: " + sender.targetControlId);
- }
-
-
-
-
-
- Specifies the name of the client-side function that will be called before the
- spell check dialog closes.
-
-
- The function should accept two parameters: sender (the dialog opener client object) and arguments.
-
-
-
- function onDialogClosed(sender, args)
- {
- alert("spell: " + sender.get_id()+ " dialog closed");
- }
-
-
-
-
- Gets or sets the skin name for the control user interface.
- A string containing the skin name for the control user interface. The default is string.Empty.
-
-
- If this property is not set, the control will render using the skin named "Default".
- If EnableEmbeddedSkins is set to false, the control will not render skin.
-
-
-
-
- Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
-
-
- If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.
-
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded client scripts or not.
-
-
- If EnableEmbeddedScripts is set to false you will have to register the needed script files by hand.
-
-
-
-
-
- Gets or sets a value indicating where the soell will look for its .resx localization files.
- By default these files should be in the App_GlobalResources folder. However, if you cannot put
- the resource files in the default location or .resx files compilation is disabled for some reason
- (e.g. in a DotNetNuke environment), this property should be set to the location of the resource files.
-
-
- A relative path to the dialogs location. For example: "~/controls/RadControlsResources/".
-
-
- If specified, the LocalizationPath
- property will allow you to load the spell localization files from any location in the current
- web application.
-
-
-
- Gets or sets the value, indicating whether to render links to the embedded skins or not.
-
-
- If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
-
-
-
-
- Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
-
-
- If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
-
-
-
-
-
- This class is a container for the Spell Dialog UI
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Gets or sets a string containing the localization language for the RadSpell Dialog
-
-
-
-
- Gets or sets a string containing the localization language for the RadSpell Dialog
-
-
-
-
- Specifies the visibility and position of scrollbars in a RadMultiPage control.
-
-
-
-
- No scroll bars are displayed. Overflowing content will be visible.
-
-
-
-
- Displays only a horizontal scroll bar. The scroll bar is always visible.
-
-
-
-
- Displays only a vertical scroll bar. The scroll bar is always visible.
-
-
-
-
- Displays both a horizontal and a vertical scroll bar. The scroll bars are always visible.
-
-
-
-
- Displays, horizontal, vertical, or both scroll bars as necessary (the content overflows the RadMultiPage boundaries).
- Otherwise, no scroll bars are shown.
-
-
-
-
- No scroll bars are displayed. Overflowing content is clippet at RadMultiPage boundaries.
-
-
-
-
- Provides data for the events of the RadMultiPage control.
-
-
-
-
- Initializes a new instance of the RadMultiPageEventArgs class.
-
-
- A RadPageView which represents a page view in the
- RadMultiPage control.
-
-
-
-
- Gets the referenced page view in the RadMultiPage control when the event is raised.
-
-
- The referenced page view in the RadMultiPage control when the event is raised.
-
-
- Use this property to programmatically access the page view referenced in the RadMultiPage control when the event is raised.
-
-
-
-
- Represents the method that handles the event provided by the control.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- The RadPageView class represents a single page in the
- RadMultiPage control.
-
-
-
-
- Gets the RadMultiPage control which contains the current RadPageView
-
-
- A RadMultiPage object which contains the current RadPageView.
- Null (Nothing in VB.NET) is returned if the current RadPageView is not added in a RadMultiPage control.
-
-
-
-
- Gets or sets a value indicating whether the current RadPageView is selected.
-
-
- true if the current RadPageView is selected; otherwise
- false. The default value is false.
-
-
- Use the Selected property to select a RadPageView object. There can be only one selected
- RadPageView at a time within a RadMultiPage control.
-
-
-
-
- Gets the zero-based index of the current RadPageView object.
-
-
- The zero-based index of the current RadPageView; -1 will be returned if the current RadPageView object is not added
- in a RadMultiPage control.
-
-
-
-
- A control which contains controls. Only one page view can be visible at a time.
-
-
- RadMultiPage is usually used with RadTabStrip to create paged data entry forms. Use the
- property to associate a RadMultiPage control with RadTabStrip.
-
-
-
-
- Finds a RadPageView with the specified ID.
-
- The ID of the RadPageView
-
- A RadPageView with the specified ID. Null (Nothing) is returned if there is no
- RadPageView with the specified ID.
-
-
-
-
-
-
-
-
- Gets or sets the index of the selected RadMultiPage.
-
-
- The index of the currently selected RadMultiPage. The default value is -1,
- which means that no RadMultiPage is selected.
-
-
-
-
- Gets a RadPageViewCollection that represents the RadMultiPage
- controls int the current RadMultiPage instance.
-
-
-
-
- Gets or sets a value indicating whether to render only the currently selected RadMultiPage.
-
-
- True if only the current RadMultiPage should be rendered; otherwise false.
- The default value is false which means all pageviews will be rendered.
-
-
- Use the RenderSelectedPageOnly to make the RadMultiPage control render only the selected RadMultiPage.
- This can save output size because by default all pageviews are rendered. If RenderSelectedPageOnly is set to true
- RadMultiPage will make a request to the server in order to change the selected pageview.
-
-
-
-
- Gets or sets the visibility and position of scroll bars in the RadMultiPage control.
-
-
- One of the values. The default value is None.
-
-
- Use this property to customize the visibility and position of scroll bars. By default any overflowing content is visible.
-
-
-
-
-
-
-
-
-
-
-
-
- Occurs when page views are added programmatically to the RadMultiPage control. It also occurs after postback when
- the RadMultiPage control recreates its page views from ViewState.
-
-
- The example below starts by defining a dynamic page view and adding a control (i.e.
- Label) to the new page view.
-
- protected void Page_Load(object sender, System.EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- PageView view = new RadPageView();
- view.ID = "dynamicPageView";
- RadMultiPage1.PageViews.Add(view);
- }
- }
-
- protected void RadMultiPage1_PageViewCreated(object sender, Telerik.Web.UI.RadMultiPageEventArgs e)
- {
- Label l = new Label();
- l.ID = "dynamicLabel";
- l.Text = "Programatically created label";
- e.PageView.Controls.Add(l);
- }
-
-
- Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
- If Not Page.IsPostBack Then
- Dim view As PageView = New RadPageView()
- view.ID = "dynamicPageView"
- RadMultiPage1.PageViews.Add(view)
- End If
- End Sub
-
- Protected Sub RadMultiPage1_PageViewCreated(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadMultiPageEventArgs) Handles RadMultiPage1.PageViewCreated
- Dim l As New Label()
- l.ID = "dynamicLabel"
- l.Text = "Programatically created label"
- e.PageView.Controls.Add(l)
- End Sub
-
-
-
- Use this event when you need to create page views from code behind. Controls added dynamically should be created in
- the PageViewCreated event handler.
-
-
-
-
- Specifies the alignment of tabs within the RadTabStrip control.
-
-
-
-
- The Tabs will be aligned to the left.
-
-
-
-
- The Tabs will be centered in the middle.
-
-
-
-
- The Tabs will be aligned to the right.
-
-
-
-
- The Tabs will be justified.
-
-
-
-
- Specifies the way tabs can be oriented
-
-
-
-
- RadTabStrip is above the content (e.g. RadMultiPage).
- Child tabs (if any) are shown below parent tabs.
-
-
-
-
- RadTabStrip is below the content (e.g. RadMultiPage).
- Child tabs (if any) are shown above parent tabs.
-
-
-
-
- RadTabStrip is on the right side of the content (e.g. RadMultiPage).
- Child tabs (if any) are shown on the left side of parent tabs.
-
-
-
-
- RadTabStrip is on the left side of the content (e.g. RadMultiPage).
- Child tabs (if any) are shown on the right side of parent tabs.
-
-
-
-
- The position of the scroll buttons when the RadTabStrip.ScrollChildren
- property is set to true.
-
-
-
-
- The buttons are to the left of tabs.
-
-
-
-
- The tabs are between the left and right scroll buttons.
-
-
-
-
- The buttons are to the right of the tabs.
-
-
-
-
- Provides data for the events of the RadTabStrip control.
-
-
-
-
- Initializes a new instance of the
- RadTabStripEventArgs class.
-
-
- A RadTab which represents a tab in the
- RadTabStrip control.
-
-
-
-
- Gets the referenced tab in the RadTabStrip control when the event is raised.
-
-
- The referenced tab in the RadTabStrip control when the event is raised.
-
-
- Use this property to programmatically access the tab referenced in the RadTabStrip control when the event is raised.
-
-
-
-
- Represents the method that handles the events provided by the control.
-
-
-
-
- Defines properties that tab containers (RadTabStrip,
- RadTab) should implement.
-
-
-
-
- Gets the parent IRadTabContainer.
-
-
-
-
- Gets the collection of child tabs.
-
-
- A RadTabCollection which represents the child tabs of
- the IRadTabContainer.
-
-
-
-
- Gets or sets the index of the selected child tab.
-
-
- The zero based index of the selected tab. The default value is -1 (no child tab is selected).
-
-
- Use the SelectedIndex property to programmatically specify the selected
- child tab in a IRadTabContainer (RadTabStrip or RadTab).
- To clear the selection set the SelectedIndex property to -1.
-
-
-
-
- Gets the selected child tab.
-
-
- Returns the child tab which is currently selected. If no tab is selected
- (the SelectedIndex property is -1) the SelectedTab
- property will return null (Nothing in VB.NET).
-
-
-
-
- Gets or sets a value indicating whether the children of the tab will be
- scrollable.
-
-
- true if the child tabs will be scrolled; otherwise
- false. The default value is false.
-
-
-
-
- Gets or sets a value indicating whether the tabstrip should scroll directly to
- the next tab.
-
-
- true if the tabstrip should scroll to the next (or previous) tab; otherwise false.
- The default value is false.
-
-
-
- The position of the scroll buttons with regards to the tab band.
-
- This property is applicable when the
- ScrollChildren property is set to
- true; otherwise it is ignored.
-
-
- One of the TabStripScrollButtonsPosition
- enumeration values. The default value is Right.
-
-
-
-
- Gets or sets the position of the scrollable band of tabs relative to the
- beginning of the scrolling area.
-
-
- This property is applicable when the
- ScrollChildren property is set to
- true; otherwise it is ignored.
-
-
- An integer specifying the initial scrolling position (measured in pixels). The default value is 0
- (no offset from the default scrolling position). Use negative values to move the tabs to the left.
-
-
-
-
- A collection of RadPageView objects in a
- RadMultiPage control.
-
-
- The RadPageViewCollection class represents a collection of
- RadPageView objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadPageView from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of RadPageView controls in the collection.
-
-
- Use the Add method to add RadPageView controls to the collection.
-
-
- Use the Remove method to remove RadPageView controls from the
- collection.
-
-
-
-
-
-
-
- Initializes a new instance of the class.
-
- The owner of the collection.
-
-
-
- Appends the specified RadPageView to the collection.
-
-
- The RadPageView to append to the collection.
-
-
-
-
- Inserts the specified RadPageView object in the current
- RadPageViewCollection at the specified index location.
-
- The zero-based index location at which to insert the RadPageView.
- The RadPageView to insert.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Removes the specified RadPageView from the collection.
-
-
- The RadPageView to remove from the collection.
-
-
-
-
- Determines the index of the specified RadPageView in the collection.
-
-
- The zero-based index position of the specified RadPageView in the
- collection. If the specified RadPageView is not found in the collection -1 is returned.
-
-
- A RadPageView to search for in the collection.
-
-
-
-
- Gets the RadPageView at the specified index in the
- collection.
-
-
- Use this indexer to get a RadPageView from the collection at
- the specified index, using array notation.
-
-
- The zero-based index of the RadPageView to retrieve from the
- collection.
-
-
-
-
- Defines the relationship between a data item and the tab it is binding to in a
- control.
-
-
-
-
-
-
-
-
- Specifies the exact value of the ChildGroupCssClass property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ChildGroupCssClass property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledCssClass property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledCssClass property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledImageUrl property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledImageUrl property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the HoveredCssClass property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the HoveredCssClass property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the OuterCssClass property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the OuterCssClass property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the IsSeparator property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the IsSeparator property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the IsBreak property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the IsBreak property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the PerTabScrolling property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the PerTabScrolling property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ScrollChildren property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ScrollChildren property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ScrollPosition property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ScrollPosition property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the SelectedCssClass property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the SelectedCssClass property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the SelectedImageUrl property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the SelectedImageUrl property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the field, containing the SelectedIndex property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the SelectedIndex property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the exact value of the PageViewID property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the PageViewID property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ScrollButtonsPosition property of the
- RadTab that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ScrollButtonsPosition property
- value of the RadTab that will be created during
- the data binding.
-
-
-
-
- Represents a collection of objects.
-
-
-
-
- Gets the object at the specified index from the collection.
-
-
- The at the specified index in the collection.
-
-
- The zero-based index of the to retrieve.
-
-
-
- A navigation control used to create tabbed interfaces.
-
-
- The RadTabStrip control is used to display a list of tabs in a Web Forms
- page and is often used in combination with a
- RadMultiPage control for building tabbed
- interfaces. The RadTabStrip control supports the following features:
-
-
- Databinding that allows the control to be populated from various
- datasources
- Programmatic access to the RadTabStrip object model
- which allows to dynamic creation of tabstrips, populate h tabs, set
- properties.
- Customizable appearance through built-in or user-defined skins.
-
-
Tabs
-
- The RadTabStrip control is made up of tree of tabs represented
- by RadTab objects. Tabs at the top level (level 0) are
- called root tabs. A tab that has a parent tab is called a child tab. All root
- tabs are stored in the Tabs collection. Child tabs are
- stored in a parent tab's Tabs collection.
-
-
- Each tab has a Text and a Value property.
- The value of the Text property is displayed in the RadTabStrip control,
- while the Value property is used to store any additional data about the tab,
- such as data passed to the postback event associated with the tab. When clicked, a tab can
- navigate to another Web page indicated by the NavigateUrl property.
-
-
-
-
-
- Initializes a new instance of the RadTabStrip class.
-
-
- Use this constructor to create and initialize a new instance of the RadTabStrip
- control.
-
-
- The following example demonstrates how to programmatically create a RadTabStrip
- control.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTabStrip RadTabStrip1 = new RadTabStrip();
- RadTabStrip1.ID = "RadTabStrip1";
-
- if (!Page.IsPostBack)
- {
- //RadTabStrip persist its tab in ViewState (if EnableViewState is true).
- //Hence tabs should be created only on initial load.
-
- RadTab sportTab = new RadTab("Sport");
- RadTabStrip1.Tabs.Add(sportTab);
-
- RadTab newsTab = new RadTab("News");
- RadTabStrip1.Tabs.Add(newsTab);
- }
-
- PlaceHolder1.Controls.Add(RadTabStrip1);
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- Dim RadTabStrip1 As RadTabStrip = New RadTabStrip()
- RadTabStrip1.ID = "RadTabStrip1"
-
- If Not Page.IsPostBack Then
- 'RadTabStrip persist its tab in ViewState (if EnableViewState is true).
- 'Hence tabs should be created only on initial load.
-
- Dim sportTab As RadTab = New RadTab("Sport")
- RadTabStrip1.Tabs.Add(sportTab)
-
- Dim newsTab As RadTab = New RadTab("News")
- RadTabStrip1.Tabs.Add(newsTab)
- End If
-
- PlaceHolder1.Controls.Add(RadTabStrip1)
- End Sub
-
-
-
-
-
- Populates the RadTabStrip control from external XML file.
-
-
- The newly added items will be appended after any existing ones.
-
-
- The following example demonstrates how to populate RadTabStrip control
- from XML file.
-
- private void Page_Load(object sender, EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- RadTabStrip1.LoadContentFile("~/Data.xml");
- }
- }
-
-
- Private Sub Page_Load(sender As Object, e As EventArgs) Handles MyBase.Load
- If Not Page.IsPostBack Then
- RadTabStrip1.LoadContentFile("~/Data.xml")
- End If
- End Sub
-
-
- The name of the XML file.
-
-
-
- Gets a linear list of all tabs in the RadTabStrip control.
-
-
- An IList object containing
- all tabs in the current RadTabStrip control.
-
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose NavigateUrl
- property is equal to the specified value.
-
-
- A RadTab whose NavigateUrl property is equal to the specifed
- value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
-
- The URL to search for.
-
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Value property is equal
- to the specified value.
-
-
- A RadTab whose Value property is equal to the specifed
- value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
-
- The value to search for.
-
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Value property is equal
- to the specified value.
-
-
- A RadTab whose Value property is equal to the specifed
- value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
-
- The value to search for.
-
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Text property is equal to
- the specified value.
-
-
- A RadTab whose Text property is equal
- to the specified value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
- The value to search for.
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Text property is equal to
- the specified value.
-
-
- A RadTab whose Text property is equal
- to the specified value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the first RadTab
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindTab method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTabStrip1.FindTab(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadTab tab)
- {
- if (tab.Text == tab.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadTabStrip1.FindTab(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal tab As RadTab) As Boolean
- If tab.Text = tab.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Gets a list of all client-side changes (adding a tab, removing a tab, changing a tab's property) which have occurred.
-
-
- A list of objects which represent all client-side changes the user has performed.
- By default the ClientChanges property returns empty list. Client-changes are recorded if and only if the client-side
- methods trackChanges()/commitChanges() have been invoked.
-
-
- You can use the ClientChanges property to respond to client-side modifications such as
-
- adding a new tab
- removing existing tab
- clearing the children of a tab or the control itself
- changing a property of the tab
-
- The ClientChanges property is available in the first postback (ajax) request after the client-side modifications
- have taken place. After this moment the property will return empty list.
-
-
- The following example demonstrates how to use the ClientChanges property
-
- foreach (ClientOperation<RadTab> operation in RadTabStrip1.ClientChanges)
- {
- RadTab tab = operation.Item;
-
- switch (operation.Type)
- {
- case ClientOperationType.Insert:
- //An tab has been inserted - operation.Item contains the inserted tab
- break;
- case ClientOperationType.Remove:
- //An tab has been inserted - operation.Item contains the removed tab.
- //Keep in mind the tab has been removed from the tabstrip.
- break;
- case ClientOperationType.Update:
- UpdateClientOperation<RadTab> update = operation as UpdateClientOperation<RadTab>
- //The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- break;
- case ClientOperationType.Clear:
- //All children of have been removed - operation.Item contains the parent tab whose children have been removed. If operation.Item is null then the root tabs have been removed.
- break;
- }
- }
-
-
- For Each operation As ClientOperation(Of RadTab) In RadTabStrip1.ClientChanges
- Dim tab As RadTab = operation.Item
- Select Case operation.Type
- Case ClientOperationType.Insert
- 'A tab has been inserted - operation.Item contains the inserted tab
- Exit Select
- Case ClientOperationType.Remove
- 'A tab has been inserted - operation.Item contains the removed tab.
- 'Keep in mind the tab has been removed from the tabstrip.
- Exit Select
- Case ClientOperationType.Update
- Dim update As UpdateClientOperation(Of RadTab) = TryCast(operation, UpdateClientOperation(Of RadTab))
- 'The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- Exit Select
- Case ClientOperationType.Clear
- 'All children of have been removed - operation.Item contains the parent tab whose children have been removed. If operation.Item is Nothing then the root tabs have been removed.
- Exist Select
- End Select
- Next
-
-
-
-
-
- Gets or sets a value indicating whether the immediate children of the RadTabStrip control will be
- scrollable.
-
-
- true if the child tabs will be scrollable; otherwise false. The default value is false.
-
-
-
- The position of the scroll buttons with regards to the tab band.
-
- This property is applicable when the
- ScrollChildren property is set to
- true; otherwise it is ignored.
-
-
- One of the TabStripScrollButtonsPosition
- enumeration values. The default value is Right.
-
-
-
-
- Gets or sets the position of the scrollable band of tabs relative to the
- beginning of the scrolling area.
-
-
- This property is applicable when the ScrollChildren property is set to
- true; otherwise it is ignored.
-
-
- An integer specifying the initial scrolling position (measured in pixels). The default value is 0
- (no offset from the default scrolling position). Use negative values to move the tabs to the left.
-
-
-
-
- Gets or sets a value indicating whether the tabstrip should scroll directly to
- the next tab.
-
-
- true if the tabstrip should scroll to the next (or previous) tab; otherwise false.
- The default value is false.
-
-
- By default tabs are scrolled smoothly. If you want the tabstrip to scroll directly
- to the next (or previous) tab set this property to true. This
- property is applicable when the ScrollChildren
- property is set to true; otherwise it is ignored.
-
-
-
-
- Gets or sets the index of the selected child tab.
-
-
- The zero based index of the selected tab. The default value is -1 (no child tab is selected).
-
-
- Use the SelectedIndex property to programmatically specify the selected
- child tab in a IRadTabContainer (RadTabStrip or RadTab).
- To clear the selection set the SelectedIndex property to -1.
-
-
- The following example demonstrates how to programmatically select a tab by using
- the SelectedIndex property.
-
- void Page_Load(object sender, EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- RadTab newsTab = new RadTab("News");
- RadTabStrip1.Tabs.Add(newsTab);
-
- RadTabStrip1.SelectedIndex = 0; //This will select the "News" tab
-
- RadTab cnnTab = new RadTab("CNN");
- newsTab.Tabs.Add(cnnTab);
-
- RadTab nbcTab = new RadTab("NBC");
- newsTab.Tabs.Add(nbcTab);
-
- newsTab.SelectedIndex = 1; //This will select the "NBC" child tab of the "News" tab
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- If Not Page.IsPostBack Then
- Dim newsTab As RadTab = New RadTab("News")
- RadTabStrip1.Tabs.Add(newsTab)
-
- RadTabStrip1.SelectedIndex = 0 'This will select the "News" tab
-
- Dim cnnTab As RadTab = New RadTab("CNN")
- newsTab.Tabs.Add(cnnTab)
-
- Dim nbcTab As RadTab = New RadTab("NBC")
- newsTab.Tabs.Add(nbcTab)
-
- newsTab.SelectedIndex = 1 'This will select the "NBC" child tab of the "News" tab
- End If
- End Sub
-
-
-
-
-
- Gets the selected child tab.
-
-
- Returns the child tab which is currently selected. If no tab is selected
- (the SelectedIndex property is -1) the SelectedTab
- property will return null (Nothing in VB.NET).
-
-
-
-
- Gets a RadTabCollection object that contains the root tabs of the current RadTabStrip control.
-
-
- A RadTabCollection that contains the root tabs of the current RadTabStrip control. By default
- the collection is empty (RadTabStrip has no children).
-
-
- Use the Tabs property to access the child tabs of RadTabStrip. You can also use the Tabs property to
- manage the root tabs. You can add, remove or modify tabs from the Tabs collection.
-
-
- The following example demonstrates how to programmatically modify the properties of root tabs.
-
- RadTabStrip1.Tabs[0].Text = "Example";
- RadTabStrip1.Tabs[0].NavigateUrl = "http://www.example.com";
-
-
- RadTabStrip1.Tabs(0).Text = "Example"
- RadTabStrip1.Tabs(0).NavigateUrl = "http://www.example.com"
-
-
-
-
- Gets or sets the template for displaying all tabs in the control.
-
- An object implementing the ITemplateThe default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
- To specify unique display for specific tabs use the
- property of the class.
-
-
-
- The following example demonstrates how to customize the appearance of all tabs
-
- <telerik:RadTabStrip runat="server" ID="RadTabStrip1">
- <TabTemplate>
- <%# DataBinder.Eval(Container, "Text") %>
- <img style="margin-left: 10px" src="Images/delete.gif" alt="delete"/>
- </TabTemplate>
- <Tabs>
- <telerik:RadTab Text="Products">
- </telerik:RadTab>
- <telerik:RadTab Text="Services">
- </telerik:RadTab>
- <telerik:RadTab Text="Corporate">
- </telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
- protected void Page_Load(object sender, System.EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- //Required to evaluate the databinding expressions inside the template (<%# DataBinder.Eval)%>
- RadTabStrip1.DataBind();
- }
- }
-
-
- Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
- If Not Page.IsPostBack Then
- RadTabStrip1.DataBind()
- End If
- End Sub
-
-
-
-
-
- Gets or sets a value indicating whether tabs should postback when clicked.
-
-
- True if tabs should postback; otherwise false. The default value is false.
-
-
- RadTabStrip will postback provided one of the following conditions is met:
-
-
- The AutoPostBack property is set to true.
-
-
- The user has subscribed to the TabClick event.
-
-
-
-
-
-
- Gets a collection of objects that define the relationship
- between a data item and the tab it is binding to.
-
-
-
-
- Gets or sets a value that indicates whether child tabs are cleared before
- data binding.
-
-
- The AppendDataBoundTabs property allows you to add items to
- the RadTabStrp control before data binding occurs. After data binding, the items
- collection contains both the items from the data source and the previously added
- items.
- The value of this property is stored in view state.
-
-
- True if child tabs should not be cleared before databinding;
- otherwise false. The default value is false (child
- items will be cleared before databinding).
-
-
-
-
- Gets or sets the maximum number of levels to bind to the RadTabStrip control.
-
-
- The maximum number of levels to bind to the RadTabStrip control. The default is -1, which binds all the levels in the data source to the control.
-
-
- When binding the RadTabStrip control to a data source, use the MaxDataBindDepth
- property to limit the number of levels to bind to the control. For example, setting this property to 2 binds only
- the root tabs and their immediate children. All remaining records in the data source are ignored.
-
-
-
-
- Gets or sets the field of the data source that provides the text content of the tabs.
-
-
- A string that specifies the field of the data source that provides the text content of the tabs.
- The default value is empty string.
-
-
- Use the DataTextField property to specify the field of the data source (in most cases the name of the database column)
- which provides values for the Text property of databound tabs. The DataTextField property is
- taken into account only during data binding.
-
-
- The following example demonstrates how to use the DataTextField.
-
- DataTable data = new DataTable();
- data.Columns.Add("MyText");
-
- data.Rows.Add(new object[] {"Tab Text 1"});
- data.Rows.Add(new object[] {"Tab Text 2"});
-
- RadTabStrip1.DataSource = data;
- RadTabStrip1.DataTextField = "MyText"; //"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataBind();
-
-
- Dim data As new DataTable();
- data.Columns.Add("MyText")
-
- data.Rows.Add(New Object() {"Tab Text 1"})
- data.Rows.Add(New Object() {"Tab Text 2"})
-
- RadTabStrip1.DataSource = data
- RadTabStrip1.DataTextField = "MyText" '"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataBind()
-
-
-
-
-
- Gets or sets the field of the data source that provides the value of the tabs.
-
-
- A string that specifies the field of the data source that provides the value of the tabs.
- The default value is empty string.
-
-
- Use the DataValueField property to specify the field of the data source (in most cases the name of the database column)
- which provides the values for the Value property of databound tabs. The DataValueField property is
- taken into account only during data binding. If the DataValueField property is not set the Value
- property of databound tabs will have its default value - empty string.
-
-
- The following example demonstrates how to use the DataValueField.
-
- DataTable data = new DataTable();
- data.Columns.Add("MyText");
- data.Columns.Add("MyValue");
-
- data.Rows.Add(new object[] {"Tab Text 1", "Tab Value 1"});
- data.Rows.Add(new object[] {"Tab Text 2", "Tab Value 2"});
-
- RadTabStrip1.DataSource = data;
- RadTabStrip1.DataTextField = "MyText"; //"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataValueField = "MyValue"; //"MyValue" column provides values for the Value property of databound tabs
- RadTabStrip1.DataBind();
-
-
- Dim data As new DataTable();
- data.Columns.Add("MyText")
- data.Columns.Add("MyValue")
-
- data.Rows.Add(New Object() {"Tab Text 1", "Tab Value 1"})
- data.Rows.Add(New Object() {"Tab Text 2", "Tab Value 2"})
-
- RadTabStrip1.DataSource = data
- RadTabStrip1.DataTextField = "MyText" '"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataValueField = "MyValue" '"MyValue" column provides values for the Value property of databound tabs
- RadTabStrip1.DataBind()
-
-
-
-
-
- Gets or sets the field of the data source that provides the URL to which tabs navigate.
-
-
- A string that specifies the field of the data source that provides the URL to which tabs will navigate.
- The default value is empty string.
-
-
- Use the DataNavigateUrlField property to specify the field of the data source (in most cases the name of the database column)
- which provides the values for the NavigateUrl property of databound tabs.
- The DataNavigateUrlField property is taken into account only during data binding. If the DataNavigateUrlField property
- is not set the NavigateUrl property of databound tabs will have its default value - empty string.
-
-
- The following example demonstrates how to use the DataNavigateUrlField.
-
- DataTable data = new DataTable();
- data.Columns.Add("MyText");
- data.Columns.Add("MyUrl");
-
- data.Rows.Add(new object[] {"Tab Text 1", "http://www.example.com/page1.aspx"});
- data.Rows.Add(new object[] {"Tab Text 2", "http://www.example.com/page2.aspx"});
-
- RadTabStrip1.DataSource = data;
- RadTabStrip1.DataTextField = "MyText"; //"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataNavigateUrlField = "MyUrl"; //"MyUrl" column provides values for the NavigateUrl property of databound tabs
- RadTabStrip1.DataBind();
-
-
- Dim data As new DataTable();
- data.Columns.Add("MyText")
- data.Columns.Add("MyUrl")
-
- data.Rows.Add(New Object() {"Tab Text 1", "http://www.example.com/page1.aspx"})
- data.Rows.Add(New Object() {"Tab Text 2", "http://www.example.com/page2.aspx"})
-
- RadTabStrip1.DataSource = data
- RadTabStrip1.DataTextField = "MyText" '"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataValueField = "MyUrl" '"MyUrl" column provides values for the NavigateUrl property of databound tabs
- RadTabStrip1.DataBind()
-
-
-
-
-
- Gets or sets the field from the data source which is the "child" column in the
- "parent-child" relationship used to databind the RadTabStrip
- control.
-
-
- A string that specifies the field of the data source that will be the "child"
- column during databinding. The default is empty string.
-
-
- RadTabStrip requires both DataFieldID and
- DataFieldParentID properties to be set in order to be hierarchically databound.
-
-
- The following example demonstrates how to use DataFieldID and DataFieldParentID.
-
- DataTable data = new DataTable();
- data.Columns.Add("MyText");
- data.Columns.Add("MyID", typeof(int));
- data.Columns.Add("MyParentID", typeof(int));
-
- data.Rows.Add(new object[] {"Root Tab 1", 1, null});
- data.Rows.Add(new object[] {"Child Tab 1.1", 3, 1});
- data.Rows.Add(new object[] {"Root Tab 2", 2, null});
- data.Rows.Add(new object[] {"Child Tab 2.1", 4, 2});
-
- RadTabStrip1.DataSource = data;
- RadTabStrip1.DataTextField = "MyText"; //"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataFieldID = "MyID"; //"MyID" column provides values for the "child" column in the relation.
- RadTabStrip1.DataFieldParentID = "MyParentID"; //"MyParentID" column provides values for the "parent" column in the relation.
- RadTabStrip1.DataBind();
-
-
- Dim data As New DataTable()
- data.Columns.Add("MyText")
- data.Columns.Add("MyID", GetType(Integer))
- data.Columns.Add("MyParentID", GetType(Integer))
-
- data.Rows.Add(New Object() {"Root Tab 1", 1, Nothing})
- data.Rows.Add(New Object() {"Child Tab 1.1", 3, 1})
- data.Rows.Add(New Object() {"Root Tab 2", 2, Nothing})
- data.Rows.Add(New Object() {"Child Tab 2.1", 4, 2})
-
- RadTabStrip1.DataSource = data
- RadTabStrip1.DataTextField = "MyText" '"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataFieldID = "MyID" '"MyID" column provides values for the "child" column in the relation.
- RadTabStrip1.DataFieldParentID = "MyParentID" '"MyParentID" column provides values for the "parent" column in the relation.
- RadTabStrip1.DataBind()
-
-
-
-
-
- Gets or sets the field from the data source which is the "parent" column in the
- "parent-child" relationship used to databind the RadTabStrip
- control.
-
-
- A string that specifies the field of the data source that will be the "parent"
- column during databinding. The default is empty string.
-
-
-
- RadTabStrip requires both DataFieldID and
- DataFieldParentID properties to be set in order to be hierarchically databound.
-
-
- The value of the column specified by DataFieldParentID must be null (Nothing) for root tabs. This is a requirement
- for databinding RadTabStrip.
-
-
-
- The following example demonstrates how to use DataFieldID and DataFieldParentID.
-
- DataTable data = new DataTable();
- data.Columns.Add("MyText");
- data.Columns.Add("MyID", typeof(int));
- data.Columns.Add("MyParentID", typeof(int));
-
- data.Rows.Add(new object[] {"Root Tab 1", 1, null});
- data.Rows.Add(new object[] {"Child Tab 1.1", 3, 1});
- data.Rows.Add(new object[] {"Root Tab 2", 2, null});
- data.Rows.Add(new object[] {"Child Tab 2.1", 4, 2});
-
- RadTabStrip1.DataSource = data;
- RadTabStrip1.DataTextField = "MyText"; //"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataFieldID = "MyID"; //"MyID" column provides values for the "child" column in the relation.
- RadTabStrip1.DataFieldParentID = "MyParentID"; //"MyParentID" column provides values for the "parent" column in the relation.
- RadTabStrip1.DataBind();
-
-
- Dim data As New DataTable()
- data.Columns.Add("MyText")
- data.Columns.Add("MyID", GetType(Integer))
- data.Columns.Add("MyParentID", GetType(Integer))
-
- data.Rows.Add(New Object() {"Root Tab 1", 1, Nothing})
- data.Rows.Add(New Object() {"Child Tab 1.1", 3, 1})
- data.Rows.Add(New Object() {"Root Tab 2", 2, Nothing})
- data.Rows.Add(New Object() {"Child Tab 2.1", 4, 2})
-
- RadTabStrip1.DataSource = data
- RadTabStrip1.DataTextField = "MyText" '"MyText" column provides values for the Text property of databound tabs
- RadTabStrip1.DataFieldID = "MyID" '"MyID" column provides values for the "child" column in the relation.
- RadTabStrip1.DataFieldParentID = "MyParentID" '"MyParentID" column provides values for the "parent" column in the relation.
- RadTabStrip1.DataBind()
-
-
-
-
-
- Gets or sets the formatting string used to control how text to the tabstrip
- control is displayed.
-
-
-
- Use the DataTextFormatString property to provide a custom display format for text of the tabs.
- The data format string consists of two parts, separated by a colon, in the form { A: Bxx }.
- For example, the formatting string {0:F2} would display a fixed point number with two decimal places.
-
-
- The entire string must be enclosed in braces to indicate that it is a format string and not a literal string.
- Any text outside the braces is displayed as literal text.
-
-
- The value before the colon (A in the general example) specifies the parameter index in a zero-based list of parameters.
- This value can only be set to 0.
-
-
-
-
-
- Gets the innermost selected tab in a hierarchical RadTabStrip control.
-
-
- In hierarchical tabstrips this property returns the innermost selected
- tab.
-
-
- Returns the inner most selected child tab in hierarchical tabstrip scenarios.
- Null (Nothing in VB.NET) if no tab is selected.
-
-
-
-
- Gets or sets the name of the validation group to which this validation
- control belongs.
-
-
- The name of the validation group to which this validation control belongs. The
- default is an empty string (""), which indicates that this property is not set.
-
-
- This property works only when CausesValidation
- is set to true.
-
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when a tab
- from the tabstrip is clicked.
-
-
- The URL of the Web page to post to from the current page when a tab from the
- tabstrip control is clicked. The default value is an empty string (""), which causes
- the page to post back to itself.
-
-
-
-
- Gets or sets the ID of the RadMultiPage control that
- will be controlled by the current RadTabStrip control.
-
-
- You should use different value depending on the following conditions:
-
-
- Use the ID property of the RadMuitiPage control if the RadMultiPage control is in
- the same INamingContainer (user control, page, content page, master page) as the current RadTabStrip control.
-
-
- Use the UniqueID property of the RadMuitiPage control if the RadMultiPage
- control is in a different INamingContainer (user control, page, content page, master page) than
- the current RadTabStrip control.
-
-
-
-
- The ID of the associated RadMultiPage. The default value is empty string.
-
-
- The following example demonstrates how to associate a RadMultiPage
- control with a RadTabStrip control through the
- MultiPageID property.
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- MultiPageID="RadMultiPage1">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
- <telerik:RadMultiPage id="RadMultiPage1"
- runat="server">
- .....
- </telerik:RadMultiPage>
-
-
-
-
-
- Gets the associated RadMultiPage control if the
- MultiPageID property is set.
-
-
- The RadMultiPage control associated with the
- current RadTabStrip control. Will return null (Nothing in VB.NET) if the MultiPageID
- is not set or a corresponding RadMultiPage control cannot be found
-
-
-
-
- Gets or sets a value indicating whether the tabstrip should postback when the user clicks the currently selected tab.
-
-
- True if the tabstrip should postback when the user clicks the currently selected tab; otherwise false.
- The default value is false.
-
-
-
-
- Gets or sets a value indicating the orientation of child tabs within the
- RadTabStrip control.
-
-
- One of the TabStripOrientation values.
- The default value is HorizontalTopToBottom.
-
-
-
- Gets or sets the alignment of the tabs in the RadTabStrip control.
-
- One of the TabStripAlign enumeration values. The
- default value is Left.
-
-
-
-
- Gets or sets a value indicating whether the row of the selected tab should move
- to the bottom.
-
-
- true if the row containing the selected tab should be moved to
- the bottom; otherwise false. The default value is
- false.
-
-
- Use the ReorderTabsOnSelect property to mimic the behavior of the
- Windows tabstrip control.
-
-
-
-
- Shows or hides the image at the base of the first level of tabs.
-
-
- true if line is visible;
- otherwise, false. The default value is false.
-
-
-
-
- Controls whether the subitems of the tabstrip will have different styles than the main items.
-
-
- true if styling should be different;
- otherwise, false. The default value is false.
-
-
-
-
- Gets or sets a value determining whether child tabs are unselected when a parent
- tab is unselected.
-
-
- true if child tabs are unselected when a parent tab is
- unselected. false if the tabs persist their state even when hidden.
- The default value is false.
-
-
-
-
- Gets or sets a value indicating whether validation is performed when a tab within
- the RadTabStrip control is selected.
-
-
- true if validation is performed when a tab is selected;
- otherwise, false. The default value is true.
-
-
- By default, page validation is performed when a tab is selected. Page
- validation determines whether the input controls associated with a validation
- control on the page all pass the validation rules specified by the validation
- control. You can specify or determine whether validation is performed on both the
- client and the server when a tab is clicked by using the CausesValidation
- property. To prevent validation from being performed, set the
- CausesValidation property to false.
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after selecting a tab.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientTabSelected property to specify a JavaScript
- function that will be executed after a tab is selected - either by left-clicking it
- with a mouse or hitting enter after tabbing to that tab.
- Two parameters are passed to the handler
-
- sender (the client-side RadTabStrip object)
-
- eventArgs with one property
-
-
tab - the instance of the selected tab
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientTabSelected property.
-
- <script language="javascript">
- function ClientTabSelectedHandler(sender, eventArgs)
- {
- var tabStrip = sender;
- var tab = eventArgs.get_tab();
-
- alert("You have selected the " + tab.get_text() + " tab in the " + tabStrip.get_id() +
- "tabstrip.");
- }
- </script>
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientTabSelected="ClientTabSelectedHandler">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- before the browser context menu shows (after right-clicking an item).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientContextMenu property to specify a JavaScript
- function that will be executed before the context menu shows after right clicking a
- tab.
- Two parameters are passed to the handler
-
- sender (the client-side RadTabStrip object)
-
- eventArgs with two properties
-
-
tab - the instance of the selected tab
-
domEvent - the browser DOM event
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientContextMenu property.
-
- <script language="javascript">
- function OnContextMenuHandler(sender, eventArgs)
- {
- var tabStrip = sender;
- var tab = eventArgs.get_tab();
-
- alert("You have right-clicked the " + tab.get_text() + " tab in the " + tabStrip.get_id() +
- "tabstrip.");
- }
- </script>
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientContextMenu="OnContextMenuHandler">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- when the user double-clicks a tab.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientDoubleClick property to specify a JavaScript
- function that will be executed when the user double-clicks a tab.
-
- Two parameters are passed to the handler
-
- sender (the client-side RadTabStrip object)
-
- eventArgs with two properties
-
-
tab - the instance of the selected tab
-
domEvent - the browser DOM event
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientDoubleClick property.
-
- <script language="javascript">
- function OnDoubleClickHandler(sender, eventArgs)
- {
- var tabStrip = sender;
- var tab = eventArgs.get_tab();
-
- alert("You have double-clicked the " + tab.get_text() + " tab in the " + tabStrip.get_id() +
- "tabstrip.");
- }
- </script>
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientDoubleClick="OnDoubleClickHandler">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called just
- prior to selecting a tab.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientTabSelecting property to specify a
- JavaScript function that will be executed prior to tab selecting - either by
- left-clicking it with a mouse or hitting enter after tabbing to that tab. You can
- cancel that event (prevent tab selecting) by seting the cancel property of the event argument to true.
- Two parameters are passed to the handler
-
- sender (the client-side RadTabStrip object)
-
- eventArgs with one property
-
-
tab - the instance of the selected tab
-
cancel - whether to cancel the event
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientTabSelecting property.
-
- <script language="javascript">
- function ClientTabSelectingHandler(sender, eventArgs)
- {
- var tabStrip = sender;
- var tab = eventArgs.get_tab();
-
- alert("You will be selecting the " + tab.get_text() + " tab in the " + tabStrip.get_id() +
- " tabstrip.");
-
- if (tab.Text == "Education")
- {
- alert("Education cannot be selected");
- eventArgs.set_cancel(true);
- }
- }
- </script>
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientTabSelecting="ClientTabSelectedHandler">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse hovers a tab in the RadTabStrip control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientMouseOver property to specify a JavaScript
- function that is called when the user hovers a tab with the mouse.
- Two parameters are passed to the handler:
-
- sender (the client-side RadTabStrip object);
-
- eventArgs with two properties
-
-
tab - the instance of the tab that is being hovered
-
domEvent - the instance of the browser event.
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientMouseOver property.
-
- <script language="javascript">
- function ClientMouseOverHandler(sender, eventArgs)
- {
- var tabStrip = sender;
- var tab = eventArgs.get_tab();
- var domEvent = eventArgs.get_domEvent();
-
- alert("You have just moved over the " + tab.get_text() + " tabs in the " +
- tabStrip.get_id() + " tabstrip");
- alert("Mouse coordinates: " + domEvent.clientX + ":" +
- domEvent.clientY);
- }
- </script>
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientMouseOver="ClientMouseOverHandler">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse leaves a tab in the RadTabStrip control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientMouseOut property to specify a JavaScript
- function that is executed whenever the user moves the mouse
- away from a particular tab in the RadTabStrip control.
- Two parameters are passed to the handler:
-
- sender (the client-side RadTabStrip
- object);
-
- eventArgs with two properties:
-
-
tab - the instance of the tab we are moving
- away from;
-
domEvent - the instance of the browser
- event.
-
-
-
-
-
- The following example demonstrates how to use the OnClientMouseOut
- property.
-
- <script language="javascript">
- function ClientMouseOutHandler(sender, eventArgs)
- {
- var tabStrip = sender;
- var tab = eventArgs.Tab;
- var domEvent = eventArgs.get_domEvent();
- alert("You have just moved out of " + tab.get_text() + " in
- the " + tabStrip.get_id() + " tabstrip.");
- alert("Mouse coordinates: " + domEvent.clientX + ":" +
- domEvent.clientY);
- }
- </script>
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientMouseOut="ClientMouseOutHandler">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after a tab is unselected (i.e. the user has selected another tab).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientTabUnSelected property to specify a
- JavaScript function that is executed after a tab is
- unselected.
- Two parameters are passed to the handler:
-
- sender (the client-side RadTabStrip
- object);
-
- eventArgs with one property:
-
-
tab - the instance of the tab which is
- unselected;
-
-
-
-
-
- The following example demonstrates how to use the OnClientMouseOut
- property.
-
- <script language="javascript">
- function ClientTabUnSelectedHandler(sender, eventArgs)
- {
- var tabStrip = sender;
- var tab = eventArgs.get_tab();
-
- alert("You have unselected the " + tab.get_text() + " tab in the " + tabStrip.get_id() +
- "tabstrip.");
- }
- </script>
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientTabUnSelected="ClientTabUnSelectedHandler">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets the name of the javascript function called when the control is fully
- initialized on the client side.
-
-
- A string specifying the name of the javascript function called when the control
- is fully initialized on the client side. The default value is empty string.
-
-
- Use the OnClientLoad property to specify a JavaScript
- function that is executed after the control is initialized on the client side.
- A single parameter is passed to the handler, which is the
- client-side RadTabStrip object.
-
-
- The following example demonstrates how to use the OnClientLoad
- property.
-
- <script language="javascript">
- function ClientTabstripLoad(tabstrip, eventArgs)
- {
- alert(tabstrip.get_id() + " is loaded.");
- }
- </script>
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server"
- OnClientLoad="ClientTabstripLoad">
- <Tabs>
- <telerik:RadTab Text="Personal Details"></telerik:RadTab>
- <telerik:RadTab Text="Education"></telerik:RadTab>
- <telerik:RadTab Text="Computing Skills"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
- Occurs when a tab is created.
-
- The TabCreated event is raised when an tab in the RadTabStrip control is created,
- both during round-trips and at the time data is bound to the control. The TabCreated event is not raised for tabs
- which are defined inline in the page or user control.
- The TabCreated event is commonly used to initialize tab properties.
-
-
- The following example demonstrates how to use the TabCreated event
- to set the ToolTip property of each tab.
-
- protected void RadTabStrip1_TabCreated(object sender, Telerik.Web.UI.RadTabStripEventArgs e)
- {
- e.Tab.ToolTip = e.Tab.Text;
- }
-
-
- Sub RadTabStrip1_TabCreated(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTabStripEventArgs) Handles RadTabStrip1.TabCreated
- e.Tab.ToolTip = e.Tab.Text
- End Sub
-
-
-
-
- Occurs when a tab is data bound.
-
-
- The TabDataBound event is raised for each tab upon
- databinding. You can retrieve the tab being bound using the event arguments.
- The DataItem associated with the tab can be retrieved using
- the DataItem property.
-
- The TabDataBound event is often used in scenarios when you
- want to perform additional mapping of fields from the DataItem to their respective
- properties in the Tab class.
-
-
- The following example demonstrates how to map fields from the data item to
- tab properties using the TabDataBound event.
-
- protected void RadTabStrip1_TabDataBound(object sender, Telerik.Web.UI.RadTabStripEventArgs e)
- {
- e.Tab.ImageUrl = "image" + (string)DataBinder.Eval(e.Tab.DataItem, "ID") + ".gif";
- e.Tab.NavigateUrl = (string)DataBinder.Eval(e.Tab.DataItem, "URL");
- }
-
-
- Sub RadTabStrip1_TabDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTabStripEventArgs) Handles RadTabStrip1.TabDataBound
- e.Tab.ImageUrl = "image" & DataBinder.Eval(e.Tab.DataItem, "ID") & ".gif"
- e.Tab.NavigateUrl = CStr(DataBinder.Eval(e.Tab.DataItem, "URL"))
- End Sub
-
-
-
-
-
- Occurs on the server when a tab in the RadTabStrip
- control is clicked.
-
-
- The following example demonstrates how to use the TabClick event to determine the clicked tab.
-
- protected void RadTabStrip1_TabClick(object sender, Telerik.Web.UI.RadTabStripEventArgs e)
- {
- Response.Write("Clicked tab is " + e.Tab.Text);
- }
-
-
- Sub RadTabStrip1_TabClick(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTabStripEventArgs) Handles RadTabStrip1.TabClick
- Response.Write("Clicked tab is " & e.Tab.Text)
- End Sub
-
-
-
-
- Represents a tab in the RadTabStrip control.
-
-
- The RadTabStrip control is made up of tabs. Tabs which are immediate children
- of the tabstrip are root tabs. tabs which are children of root tabs are child tabs.
-
-
- A tab usually stores data in two properties, the Text property and
- the Value property. The value of the Text property is displayed
- in the RadTabStrip control, and the Value
- property is used to store additional data.
-
- To create tabs, use one of the following methods:
-
-
- Use declarative syntax to define tabs inline in your page or user control.
-
-
- Use one of the constructors to dynamically create new instances of the
- RadTab class. These tabs can then be added to the
- Tabs collection of another tab or tabstrip.
-
-
- Data bind the RadTabStrip control to a data source.
-
-
-
- When the user clicks a tab, the RadTabStrip control can navigate
- to a linked Web page, post back to the server or select that tab. If the
- NavigateUrl property of a tab is set, the
- RadTabStrip control navigates to the linked page. By default, a linked page
- is displayed in the same window or frame. To display the linked content in a different
- window or frame, use the Target property.
-
-
-
-
- Initializes a new instance of the RadTab class.
-
- Use this constructor to create and initialize a new instance of the
- RadTab class using default values.
-
-
- The following example demonstrates how to add tabs to the
- RadTabStrip control.
-
- RadTab tab = new RadTab();
- tab.Text = "News";
- tab.NavigateUrl = "~/News.aspx";
-
- RadTabStrip1.Tabs.Add(tab);
-
-
- Dim tab As New RadTab()
- tab.Text = "News"
- tab.NavigateUrl = "~/News.aspx"
-
- RadTabStrip1.Tabs.Add(tab)
-
-
-
-
-
- Initializes a new instance of the RadTab class with the
- specified text data.
-
-
- Use this constructor to create and initialize a new instance of the
- RadTab class using the specified text.
-
-
- The following example demonstrates how to add tabs to the
- RadTabStrip control.
-
- RadTab tab = new RadTab("News");
-
- RadTabStrip1.Tabs.Add(tab);
-
-
- Dim tab As New RadTab("News")
-
- RadTabStrip1.Tabs.Add(tab)
-
-
-
- The text displayed for the tab. The Text property is initialized with the value
- of this parameter.
-
-
-
-
- Initializes a new instance of the RadTab class with the
- specified text and value data.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadTab class using the specified text and value.
-
-
-
- This example demonstrates how to add tabs to the
- RadTabStrip control.
-
- RadTab tab = new RadTab("News", "NewsTabValue");
-
- RadTabStrip1.Tabs.Add(tab);
-
-
- Dim tab As New RadTab("News", "NewsTabValue")
-
- RadTabStrip1.Tabs.Add(tab)
-
-
-
- The text displayed for the tab. The Text property is initialized with the value
- of this argument.
-
-
- The value associated with the tab. The Value property is initialized with the value
- of this parameter.
-
-
-
-
- Selects recursively all parent tabs in the hierarchy.
-
-
- Use this method to programmatically select all parents of the tab. Selected tabs
- will be visible in the browser.
-
-
- The following example demonstrates how to select the parents of the tab which
- corresponds to the current URL.
-
- RadTab currentTab = RadTabStrip1.FindTabByUrl(Request.Url.PathAndQuery);
- if (currentTab != null)
- {
- currentTab.SelectParents();
- }
-
-
- Dim currentTab as RadTab = RadTabStrip1.FindTabByUrl(Request.Url.PathAndQuery)
-
- If Not currentTab Is Nothing Then
- currentTab.SelectParents()
- End If
-
-
-
-
-
- Gets or sets a value indicating whether the tab will behave as separator.
-
- true if the tab is separator; otherwise false. The default value is false.
-
-
- Use separators to visually separate the tabs. You also need to specify the width
- of the separator tab through the Width property.
-
-
-
- Gets or sets the template for displaying the tab.
-
- An object implementing the ITemplateThe default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
- To specify common display for all tabs use the
- property of the control.
-
-
-
- The following example demonstrates how to customize the appearance of a specific tab using the
- TabTemplate property
-
- <telerik:RadTabStrip ID="RadTabStrip1" runat="server">
- <Tabs>
- <telerik:RadTab>
- <TabTemplate>
- Tab 1 <img src="Images/tabIcon.gif" alt="" />
- </TabTemplate>
- </telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets the level of the current tab.
-
-
- An integer representing the level of the tab. Root tabs are level 0 (zero).
-
-
-
-
- Gets or sets a value indicating whether the tab is selected.
-
-
- true if the tab is selected; otherwise false.
- The default value is false.
-
-
- Use the Selected property to determine whether the tab is currently selected
- within its parent RadTabCollection. Setting the Selected
- property to true will deselect the previously selected tab.
-
-
-
-
- Gets the RadTabStrip instance which contains the current tab.
-
-
-
-
- Gets or sets a value indicating whether clicking on the tab will postback.
-
-
- true if the node should postback; otherwise false.
-
-
- If you subscribe to the TabClick event all tabs
- will postback. To prevent the current tab from initiating postback you can set the PostBack
- property to false.
-
-
-
- Gets the data item that is bound to the tab
-
- An Object that represents the data item that is bound to the tab. The default value is null (Nothing in Visual Basic),
- which indicates that the tab is not bound to any data item. The return value will always be null unless accessed within
- a TabDataBound event handler.
-
-
- This property is applicable only during data binding. Use it along with the
- TabDataBound event to perform additional
- mapping of fields from the data item to RadTab properties.
-
-
- The following example demonstrates how to map fields from the data item to
- RadTab properties. It assumes the user has subscribed to the
- TabDataBound event.
-
- private void RadTabStrip1_TabDataBound(object sender, Telerik.Web.UI.RadTabStripEventArgs e)
- {
- e.Tab.ImageUrl = "image" + (string)DataBinder.Eval(e.Tab.DataItem, "ID") + ".gif";
- e.Tab.NavigateUrl = (string)DataBinder.Eval(e.Tab.DataItem, "URL");
- }
-
-
- Sub RadTabStrip1_TabDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadTabStripEventArgs) Handles RadTabStrip1.TabDataBound
- e.Tab.ImageUrl = "image" & DataBinder.Eval(e.Tab.DataItem, "ID") & ".gif"
- e.Tab.NavigateUrl = CStr(DataBinder.Eval(e.Tab.DataItem, "URL"))
- End Sub
-
-
-
-
-
- Gets or sets a value indicating whether the children of the tab will be
- scrollable.
-
-
- true if the child tabs will be scrollable; otherwise false. The default value is false.
-
-
- To enable scrolling of the child tabs the ScrollChildren property
- must also be set to true.
-
-
-
- The position of the scroll buttons with regards to the tab band.
-
- This property is applicable when the
- ScrollChildren property is set to
- true; otherwise it is ignored.
-
-
- One of the TabStripScrollButtonsPosition
- enumeration values. The default value is Right.
-
-
-
-
- Gets or sets the position of the scrollable band of tabs relative to the
- beginning of the scrolling area.
-
-
- This property is applicable when the
- ScrollChildren property is set to
- true; otherwise it is ignored.
-
-
- An integer specifying the initial scrolling position (measured in pixels). The default value is 0
- (no offset from the default scrolling position). Use negative values to move the tabs to the left.
-
-
-
-
- Gets or sets a value indicating whether the tabstrip should scroll directly to
- the next tab.
-
-
- true if the tabstrip should scroll to the next (or previous) tab; otherwise false.
- The default value is false.
-
-
- By default tabs are scrolled smoothly. If you want the tabstrip to scroll directly
- to the next (or previous) tab set this property to true. This
- property is applicable when the ScrollChildren
- property is set to true; otherwise it is ignored.
-
-
-
-
- Gets or sets the index of the selected child tab.
-
-
- The zero based index of the selected tab. The default value is -1 (no child tab is selected).
-
-
- Use the SelectedIndex property to programmatically specify the selected
- child tab in a IRadTabContainer (RadTabStrip or RadTab).
- To clear the selection set the SelectedIndex property to -1.
-
-
- The following example demonstrates how to programmatically select a tab by using
- the SelectedIndex property.
-
- void Page_Load(object sender, EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- RadTab newsTab = new RadTab("News");
- RadTabStrip1.Tabs.Add(newsTab);
-
- RadTabStrip1.SelectedIndex = 0; //This will select the "News" tab
-
- RadTab cnnTab = new RadTab("CNN");
- newsTab.Tabs.Add(cnnTab);
-
- RadTab nbcTab = new RadTab("NBC");
- newsTab.Tabs.Add(nbcTab);
-
- newsTab.SelectedIndex = 1; //This will select the "NBC" child tab of the "News" tab
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- If Not Page.IsPostBack Then
- Dim newsTab As RadTab = New RadTab("News")
- RadTabStrip1.Tabs.Add(newsTab)
-
- RadTabStrip1.SelectedIndex = 0 'This will select the "News" tab
-
- Dim cnnTab As RadTab = New RadTab("CNN")
- newsTab.Tabs.Add(cnnTab)
-
- Dim nbcTab As RadTab = New RadTab("NBC")
- newsTab.Tabs.Add(nbcTab)
-
- newsTab.SelectedIndex = 1 'This will select the "NBC" child tab of the "News" tab
- End If
- End Sub
-
-
-
-
-
- Gets the selected child tab.
-
-
- Returns the child tab which is currently selected. If no tab is selected
- (the SelectedIndex property is -1) the SelectedTab
- property will return null (Nothing in VB.NET).
-
-
-
-
- Gets the IRadTabContainer instance which contains the current tab.
-
-
- The object which contains the tab. It might be an instance of the
- RadTabStrip class or the RadTab
- class depending on the hierarchy level.
-
-
- The value is of the IRadTabContainer type which is
- implemented by the RadTabStrip class and the
- RadTab class. Use the Owner property when
- recursively traversing tabs in the RadTabStrip control.
-
-
- The following example demonstrates how to make a bread crumb trail out of
- hierarchical RadTabStrip.
-
- void Page_Load(object sender, EventArgs e)
- {
- if (RadTabStrip1.SelectedIndex >= 0)
- {
- RadTab selected = RadTabStrip1.InnermostSelectedTab;
- IRadTabContainer owner = selected.Owner;
- string breadCrumbTrail = string.Empty;
- while (owner != null)
- {
- breadCrumbTrail = " > " + owner.SelectedTab.Text + breadCrumbTrail;
- owner = owner.Owner;
- }
- Label1.Text = breadCrumbTrail;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- If RadTabStrip1.SelectedIndex >= 0 Then
- Dim selected As RadTab = RadTabStrip1.InnermostSelectedTab
- Dim owner As IRadTabContainer = selected.Owner
- Dim breadCrumbTrail As String = String.Empty
- While Not owner Is Nothing
- breadCrumbTrail = " > " & owner.SelectedTab.Text & breadCrumbTrail
- owner = owner.Owner
- End While
- Label1.Text = breadCrumbTrail
- End If
- End Sub
-
-
-
-
-
- Gets a RadTabCollection object that contains the child tabs of the current tab.
-
-
- A RadTabCollection that contains the child tabs of the current tab. By default
- the collection is empty (the tab has no children).
-
-
- Use the Tabs property to access the child tabs of the current tab. You can also use the Tabs property to
- manage the children of the current tab. You can add, remove or modify tabs from the Tabs collection.
-
-
- The following example demonstrates how to programmatically modify the properties of child tabs.
-
- RadTabStrip1.Tabs[0].Tabs[0].Text = "Example";
- RadTabStrip1.Tabs[0].Tabs[0].NavigateUrl = "http://www.example.com";
-
-
- RadTabStrip1.Tabs(0).Tabs(0).Text = "Example"
- RadTabStrip1.Tabs(0).Tabs(0).NavigateUrl = "http://www.example.com"
-
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the tab is selected.
-
-
- The CSS class applied when the tab is selected. The default value is empty string.
-
-
- By default the visual appearance of selected tabs is defined in the skin CSS
- file. You can use the SelectedCssClass property to specify unique
- appearance for the current tab when it is selected.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the tab is disabled.
-
-
- The CSS class applied when the tab is disabled. The default value is empty string.
-
-
- By default the visual appearance of disabled tabs is defined in the skin CSS
- file. You can use the DisabledCssClass property to specify unique
- appearance for the tab when it is disabled.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the tab is hovered with the mouse.
-
-
- The CSS class applied when the tab is hovered. The default value is empty string.
-
-
- By default the visual appearance of hovered tabs is defined in the skin CSS
- file. You can use the HoveredCssClass property to specify unique
- appearance for the tab when it is hovered.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied on the outmost tab element (<LI>).
-
-
- The CSS class applied on the wrapping element (<LI>). The default value is empty string.
-
-
- You can use the OuterCssClass property to specify unique
- appearance for the tab, or to insert elements that are before/after the link element.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied to the HTML element
- containing the child tabs.
-
-
- The CSS class applied to the child tabs container. The default value is empty
- string.
-
-
- Tabs are rendered as LI (list item) HTML elements inside a
- UL (unordered list). The CSS class specified by the
- ChildGroupCssClass property is applied to the UL
- tag.
-
-
-
-
- <li>News
- <ul class="news">
- <li>CNN</li>
- <li>NBC</li>
- </ul>
- </li>
-
-
-
-
-
- Gets or sets a value indicating whether next tab will be displayed on a new
- line.
-
-
- true if the next tab should be displayed on a new line; otherwise false.
- The default value is false.
-
-
- Use the IsBreak property to create multi-row tabstrip. All tabs after the "break"
- tab will be displayed on a new line.
-
-
-
-
- Gets or sets the ID of the RadPageView in
- a RadMultiPage that will be switched when the tab is
- selected.
-
-
- This property overrides the default relation between the page views within a
- RadMultiPage and the tabs in a
- RadTabStrip. By default a tab activates the page view
- with the same index.
-
-
- The ID of the RadPageView that will be
- activated when the tab is selected. The default value is empty string.
-
-
-
-
- Gets or sets the text displayed for the current tab.
-
-
- The text displayed for the tab in the RadTabStrip control. The default is empty string.
-
-
- Use the Text property to specify or determine the text that is displayed for the tab
- in the RadTabStrip control.
-
-
-
-
- Gets or sets custom (user-defined) data associated with the current tab.
-
-
- A string representing the user-defined data. The default value is emptry string.
-
-
- Use the Value property to associate custom data with a RadTab object.
-
-
-
-
- Gets or sets the URL to navigate to when the current tab is clicked.
-
-
- The URL to navigate to when the tab is clicked. The default value is empty string which means that
- clicking the current tab will not navigate.
-
-
-
- By default clicking a tab will select it. If the tab has any child tabs they will be displayed. To make a tab
- navigate to some designated URL you can use the NavigateUrl property. You can optionally set the
- Target property to specify the window or frame in which to display the linked content.
-
-
- Setting the NavigateUrl property will disable tab selection and as a result the
- TabClick event won't be raised for the current tab.
-
-
-
-
-
- Gets or sets the URL to an image which is displayed next to the text of a tab.
-
-
- The URL to the image to display for the tab. The default value is empty
- string which means by default no image is displayed.
-
-
- Use the ImageUrl property to specify a custom image that will be
- displayed before the text of the current tab.
-
-
-
- The following example demonstrates how to specify the image to display for
- the tab using the ImageUrl property.
-
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server">
- <Tabs>
- <telerik:RadTabImageUrl="~/Img/inbox.gif"
- Text="Index"></telerik:RadTab>
- <telerik:RadTabImageUrl="~/Img/outbox.gif"
- Text="Outbox"></telerik:RadTab>
- <telerik:RadTabImageUrl="~/Img/trash.gif"
- Text="Trash"></telerik:RadTab>
- <telerik:RadTabImageUrl="~/Img/meetings.gif"
- Text="Meetings"></telerik:RadTab>
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
-
- Gets or sets the URL to an image which is displayed when the
- user hovers the current tab with the mouse.
-
-
- The URL to the image to display for the tab when the user hovers it with the mouse. The default value is empty
- string which means the image specified via ImageUrl will be used.
-
-
-
- Use the HoveredImageUrl property to specify a custom image that will be
- displayed when the user hovers the tab with the mouse. Setting the HoveredImageUrl
- property required the ImageUrl property to be set beforehand.
-
-
- If the HoveredImageUrl property is not set the value of the ImageUrl
- will be used instead.
-
-
-
-
-
- Gets or sets the URL to an image which is displayed when the tab is selected.
-
-
- The URL to the image to display when the tab is selected. The default value is empty
- string which means the image specified via ImageUrl will be used.
-
-
-
- Use the SelectedImageUrl property to specify a custom image that will be
- displayed when the current tab is selected. Setting the SelectedImageUrl
- property required the ImageUrl property to be set beforehand.
-
-
- If the SelectedImageUrl property is not set the value of the ImageUrl
- will be used instead.
-
-
-
-
-
- Gets or sets the URL to an image which is displayed when the tab is disabled
- (its Enabled property is set to false).
-
-
- The URL to the image to display when the tab is disabled. The default value is empty
- string which means the image specified via ImageUrl will be used.
-
-
-
- Use the DisabledImageUrl property to specify a custom image that will be
- displayed when the current tab is disabled. Setting the DisabledImageUrl
- property required the ImageUrl property to be set beforehand.
-
-
- If the DisabledImageUrl property is not set the value of the ImageUrl
- will be used instead.
-
-
-
-
-
- Gets or sets the target window or frame in which to display the Web page content associated with the current tab.
-
-
- The target window or frame to load the Web page linked to when the tab is
- selected. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without frames.
-
-
- _parent
- Renders the content in the immediate frameset parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without frames.
-
-
-
- The default value is empty string which means the linked resource will be loaded in the current window.
-
-
-
- Use the Target property to target window or frame in which to display the
- Web page content associated with the current tab. The Web page is specified by
- the NavigateUrl property.
-
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
- The Target property is taken into consideration only when the NavigateUrl
- property is set.
-
-
-
- The following example demonstrates how to use the Target property
-
-
- <telerik:RadTabStrip id="RadTabStrip1" runat="server">
- <Tabs>
- <telerik:RadTab Text="News" NavigateUrl="~/News.aspx"
- Target="_self" />
- <telerik:RadTab Text="External URL" NavigateUrl="http://www.example.com"
- Target="_blank" />
- </Tabs>
- </telerik:RadTabStrip>
-
-
-
-
- Gets the RadPageView activated when the tab is selected.
-
- The RadPageView that is activated when the tab is selected.
- The default value is null (Nothing in VB.NET).
-
-
-
-
- A collection of RadTab objects in a
- RadTabStrip control.
-
-
- The RadTabCollection class represents a collection of
- RadTab objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadTab from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of menu items in the collection.
-
-
- Use the Add method to add tabs in the collection.
-
-
- Use the Remove method to remove tabs from the
- collection.
-
-
-
-
-
-
-
- Initializes a new instance of the RadTabCollection class.
-
- The owner of the collection.
-
-
-
- Appends the specified RadTab object to the end of the current RadTabCollection.
-
-
- The RadTab to append to the end of the current RadTabCollection.
-
-
- The following example demonstrates how to programmatically add tabs in a
- RadTabStrip control.
-
- RadTab newsTab = new RadTab("News");
- RadTabStrip1.Tabs.Add(newsTab);
-
-
- Dim newsTab As RadTab = New RadTab("News")
- RadTabStrip1.Tabs.Add(newsTab)
-
-
-
-
- Appends the specified array of RadTab objects to the end of the
- current RadTabCollection.
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple tabs in a single step.
-
- RadTab[] tabs = new RadTab[] { new RadTab("First"), new RadTab("Second"), new RadTab("Third") };
- RadTabStrip1.Tabs.AddRange(tabs);
-
-
- Dim tabs() As RadTab = {New RadTab("First"), New RadTab("Second"), New RadTab("Third")}
- RadTabStrip1.Tabs.AddRange(tabs)
-
-
-
- The array of RadTab o append to the end of the current
- RadTabCollection.
-
-
-
-
- Inserts the specified RadTab object in the current
- RadTabCollection at the specified index location.
-
- The zero-based index location at which to insert the RadTab.
- The RadTab to insert.
-
-
-
- Determines the index of the specified RadTab object in the collection.
-
-
- The RadTab to locate.
-
-
- The zero-based index of tab within the current RadTabCollection,
- if found; otherwise, -1.
-
-
-
-
- Determines whether the specified RadTab object is in the current
- RadTabCollection.
-
-
- The RadTab object to find.
-
-
- true if the current collection contains the specified RadTab object;
- otherwise, false.
-
-
-
-
- Removes the specified RadTab object from the current
- RadTabCollection.
-
-
- The RadTab object to remove.
-
-
-
-
- Removes the RadTab object at the specified index
- from the current RadTabCollection.
-
- The zero-based index of the tab to remove.
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Value property is equal
- to the specified value.
-
-
- A RadTab whose Value property is equal to the specifed
- value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
-
- The value to search for.
-
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Value property is equal
- to the specified value.
-
-
- A RadTab whose Value property is equal to the specifed
- value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
-
- The value to search for.
-
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Text property is equal to
- the specified value.
-
-
- A RadTab whose Text property is equal
- to the specified value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
- The value to search for.
-
-
-
- Searches the RadTabStrip control for the first
- RadTab whose Text property is equal to
- the specified value.
-
-
- A RadTab whose Text property is equal
- to the specified value. If a tab is not found, null (Nothing in Visual Basic) is returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Returns the first RadTab
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindTab method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadTabStrip1.FindTab(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadTab tab)
- {
- if (tab.Text == tab.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadTabStrip1.FindTab(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal tab As RadTab) As Boolean
- If tab.Text = tab.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Gets the RadTab object at the specified index in
- the current RadTabCollection.
-
-
- The zero-based index of the RadTab to retrieve.
-
-
- The RadTab at the specified index in the
- current RadTabCollection.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Provides data for the ButtonDataBound event
- of the RadToolBar control.
-
-
-
-
- Initializes a new instance of the
- RadToolBarButtonEventArgs class.
-
-
- A RadToolBarItem which represents a button in the
- RadToolBar control.
-
-
-
-
- Gets the referenced button in the RadToolBar control when the
- ButtonDataBound event is raised.
-
-
- The referenced button in the RadToolBar control when the
- ButtonDataBound event is raised.
-
-
- Use this property to programmatically access the button referenced in the
- RadToolBar control when the
- ButtonDataBound event is raised.
-
-
-
-
- Represents the method that handles the ButtonDataBound
- event of a RadToolBar control.
-
- The source of the event.
- A RadToolBarButtonEventArgs that
- contains the event data.
-
- When you create a RadToolBarButtonEventHandler delegate, you identify the method that will
- handle the event. To associate the event with your event handler, add an instance of the delegate to the
- event. The event handler is called whenever the event occurs, unless you remove the delegate.
-
-
-
-
- Provides data for the events of the RadToolBar control.
-
-
-
-
- Initializes a new instance of the
- RadToolBarEventArgs class.
-
-
- A RadToolBarItem which represents an item in the
- RadToolBar control.
-
-
-
-
- Gets the referenced item in the RadToolBar control when the
- event is raised.
-
-
- The referenced item in the RadToolBar control when the event is raised.
-
-
- Use this property to programmatically access the item referenced in the
- RadToolBar control when the event is raised.
-
-
-
-
- Represents the method that handles the events of a RadToolBar control.
-
- The source of the event.
- A RadToolBarEventArgs that contains the event data.
-
- When you create a RadToolBarEventHandler delegate, you identify the method that will
- handle the event. To associate the event with your event handler, add an instance of the delegate to the
- event. The event handler is called whenever the event occurs, unless you remove the delegate.
-
-
-
-
- Specifies the expand direction of a drop down within the RadToolBar control.
-
-
-
-
- The drop down will expand upwards
-
-
-
-
- The drop down will expand downwards
-
-
-
-
- Defines properties that must be implemented to allow a control to act like
- a RadToolBarButton item in a RadToolBar.
-
-
-
-
- Gets or sets a value, indicating if the item will perform a postback.
-
-
- Used to indicate that an item should not perform a postback when
- the containing RadToolBar performs postback through.
-
-
-
- Gets or sets the value associated with the toolbar item.
- The value associated with the item. The default value is empty string.
-
- Use the Value property to specify or determine the value associated
- with the item.
-
-
-
- Gets or sets the URL to link to when the item is clicked.
-
- The URL to link to when the item is clicked. The default value is empty
- string.
-
-
- Use the NavigateUrl property to specify the URL to link to when
- the item is clicked. Use "~" (tilde) in front of an URL within the same ASP.NET
- application. When specifying external URL do not forget the protocol (e.g.
- "http://").
-
-
-
-
- Gets or sets the target window or frame to display the Web page content linked to
- when the toolbar item is clicked.
-
-
- The target window or frame to load the Web page linked to when the item is
- selected. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without
- frames.
-
-
- _parent
- Renders the content in the immediate frameset
- parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without
- frames.
-
-
- The default value is empty string.
-
-
-
- Use the Target property to specify the frame or window that displays the
- Web page linked to when the toolbar item is clicked. The Web page is specified by
- setting the NavigateUrl property.
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
-
- Gets or sets the template for displaying the item.
-
- A ITemplate implemented object that contains the template
- for displaying the item. The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
-
-
-
- Gets or sets the command name associated with the toolbar item that is passed to the
- ItemCommand event of the RadToolBar instance.
-
-
- The command name of the toolbar item. The default value is an empty string.
-
-
-
-
- Gets or sets an optional parameter passed to the Command event of the
- RadToolBar instance along with the associated
- CommandName
-
-
- An optional parameter passed to the Command event of the
- RadToolBar instance along with the associated
- CommandName. The default value is an empty string.
-
-
-
-
- Gets or sets a value indicating whether clicking the button causes page validation
- to occur.
-
-
- true if clicking the button causes page validation to occur; otherwise, false.
-
-
-
-
- Gets or sets the URL of the Web page to post to from the current page when
- the button control is clicked.
-
-
- The URL of the Web page to post to from the current page when the button
- control is clicked.
-
-
-
-
- Gets or sets the name for the group of controls for which the button control
- causes validation when it posts back to the server.
-
-
- The name for the group of controls for which the button control causes validation
- when it posts back to the server.
-
-
-
- Gets the RadToolBar instance which contains the item.
-
- Use this property to obtain an instance to the
- RadToolBar object containing the item.
-
-
-
-
- Gets or sets the text displayed for the current item.
-
-
- The text an item in the RadToolBar control displays. The default is empty string.
-
-
- Use the Text property to specify or determine the text an item displays displays
- in the RadToolBar control.
-
-
-
- Gets or sets the path to an image to display for the item.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the ImageUrl property to specify the image for the item. If
- the ImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
-
- Gets or sets the path to an image to display when the user moves the
- mouse over the item.
-
-
- The path to the image to display when the user moves the mouse over the item. The
- default value is empty string.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/Img/inbox.gif"
- HoveredImageUrl="~/Img/inboxOver.gif" Text="Index" />
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the user moves the mouse
- over the toolbar item.
-
-
- The CSS class applied when the user moves the mouse over the toolbar item. The default value is
- String.Empty.
-
-
- By default the visual appearance of a hovered toolbar items is defined in the skin CSS
- file. You can use the HoveredCssClass property to specify unique
- appearance for the toolbar item when it is hovered.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the toolbar item is
- clicked.
-
-
- The CSS class applied when the toolbar item is clicked. The default value is
- String.Empty.
-
-
- By default the visual appearance of clicked toolbar items is defined in the skin CSS
- file. You can use the ClickedCssClass property to specify unique
- appearance for the toolbar item when it is clicked.
-
-
-
-
- Gets or sets the path to an image to display for the item when the user clicks it.
-
-
- The path to the image to display when the user clicks the item. The default value
- is empty string.
-
-
- Use the ClickedImageUrl property to specify the image that will be
- used when the user clicks the item. If the ClickedImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
-
- Gets or sets the path to an image to display when the item is disabled.
-
-
- The path to the image to display when the item is disabled. The
- default value is empty string.
-
-
- Use the DisabledImageUrl property to specify the image that will be
- used when the item is disabled. If the DisabledImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the toolbar item is
- disabled.
-
-
- The CSS class applied when the toolbar item is disabled. The default value is
- String.Empty.
-
-
- By default the visual appearance of disabled toolbar items is defined in the skin CSS
- file. You can use the DisabledCssClass property to specify unique
- appearance for the toolbar item when it is disabled.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the toolBar item is
- focused after tabbing to it, or by using its AccessKey
-
-
- The CSS class applied when the toolBar item is focused. The default value is
- String.Empty.
-
-
- By default the visual appearance of focused toolBar items is defined in the skin CSS
- file. You can use the FocusedCssClass property to specify unique
- appearance for the toolBar item when it is focused.
-
-
-
-
- Gets or sets the path to an image to display when the user focuses the
- item either by tabbing to it or by using the AccessKey
-
-
- The path to the image to display when the user user focuses the
- item either by tabbing to that it or by using the AccessKey. The
- default value is empty string.
-
-
- Use the FocusedImageUrl property to specify the image that will be
- used when the item gets the focus after tabbing or using its AccessKey.
- If the FocusedImageUrl property is set to empty string the image specified
- by the ImageUrl property will be used. Use "~" (tilde) when referring to
- images within the current ASP.NET application.
-
-
-
-
- Gets or sets the position of the item image according to the item text.
-
-
- The position of the item image according to the item text. The
- default value is ToolBarImagePosition.Left.
-
-
-
-
- Defines properties that toolbar button containers
- (RadToolBarDropDown,
- RadToolBarSplitButton) should implement.
-
-
-
-
- Defines properties that toolbar item container (RadToolBar)
- should implement
-
-
-
- Gets the collection of child items.
-
- A RadToolBarItemCollection that represents the child
- items.
-
-
- Use this property to retrieve the child items. You can also use it to
- programmatically add or remove items.
-
-
-
-
- Specifies the position of the image of an item within the RadToolBar
- control according to the item text.
-
-
-
-
- The image will be displayed to the left of the text
-
-
-
-
- The image will be displayed to the right of the text
-
-
-
-
- The image will be displayed above the text
-
-
-
-
- The image will be displayed below the text
-
-
-
- Represents a single button in the RadToolBar class.
-
-
- When the user clicks a toolbar button, the RadToolBar control can
- either navigate to a linked Web page or simply post back to the server. If the
- NavigateUrl property of a toolbar button is set, the
- RadToolBar control navigates to the linked page. By default,
- a linked page is displayed in the same window or frame as the RadToolBar
- control. To display the linked content in a different window or frame, use the
- Target property.
-
-
-
-
- Represents a single item in the RadToolBar class.
-
-
- The RadToolBar control is made up of a list of toolbar items
- represented by RadToolBarItem objects (RadToolBarButton,
- RadToolBarDropDown,
- RadToolBarSplitButton). All toolbar items are stored
- in the Items collection of the toolbar.
- You can access the toolbar to which the item belongs
- by using the ToolBar property.
-
- To create the toolbar items for a RadToolBar control, use one of the
- following methods:
-
- Use declarative syntax to create static toolbar items.
- Use a constructor to dynamically create new instances of either toolbar item classes
- (RadToolBarButton,
- RadToolBarDropDown,
- RadToolBarSplitButton). These RadToolBarItem
- objects can then be added to the Items collection of the
- RadToolBar.
- Bind the RadToolBar control to a data source.
-
-
- Each toolbar item has a Text property. The Button items
- (RadToolBarButton and
- RadToolBarSplitButton) have a
- Value property. The value of the
- Text property is displayed in the RadToolBar
- control, while the Value property is used to store any
- additional data about the toolbar item.
-
-
-
-
- Gets the RadToolBar instance which contains the item.
-
- Use this property to obtain an instance to the
- RadToolBar object containing the item.
-
-
-
-
- Gets or sets the text displayed for the current item.
-
-
- The text an item in the RadToolBar control displays. The default is empty string.
-
-
- Use the Text property to specify or determine the text an item displays displays
- in the RadToolBar control.
-
-
-
- Gets or sets the path to an image to display for the item.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the ImageUrl property to specify the image for the item. If
- the ImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
- The following example demonstrates how to specify the image to display for
- a button using the ImageUrl property.
-
- <telerik:RadToolBar id="RadToolBar1"
- runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/Img/inbox.gif" Text="Index"
- />
- <telerik:RadToolBarButton ImageUrl="~/Img/outbox.gif" Text="Outbox"
- />
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets the path to an image to display when the user moves the
- mouse over the item.
-
-
- The path to the image to display when the user moves the mouse over the item. The
- default value is empty string.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/Img/inbox.gif"
- HoveredImageUrl="~/Img/inboxOver.gif" Text="Index" />
- </Items>
- </telerik:RadToolBar>
-
-
- Use the HoveredImageUrl property to specify the image that will be
- used when the user moves the mouse over the item. If the HoveredImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the user moves the mouse
- over the toolbar item.
-
-
- The CSS class applied when the user moves the mouse over the toolbar item. The default value is
- String.Empty.
-
-
- By default the visual appearance of a hovered toolbar items is defined in the skin CSS
- file. You can use the HoveredCssClass property to specify unique
- appearance for the toolbar item when it is hovered.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the toolbar item is
- clicked.
-
-
- The CSS class applied when the toolbar item is clicked. The default value is
- String.Empty.
-
-
- By default the visual appearance of clicked toolbar items is defined in the skin CSS
- file. You can use the ClickedCssClass property to specify unique
- appearance for the toolbar item when it is clicked.
-
-
-
-
- Gets or sets the path to an image to display for the item when the user clicks it.
-
-
- The path to the image to display when the user clicks the item. The default value
- is empty string.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarDropDown ImageUrl="~/Img/inbox.gif"
- ClickedImageUrl="~/Img/inboxClicked.gif" Text="DropDown1" >
- <Items>
- <telerik:RadToolBarButton Text="Mail1" ClickedImageUrl="~/Img/mail1Clicked.gif"
- />
- </Items>
- </telerik:RadToolBarDropDown>/
- </Items>
- </telerik:RadToolBar>
-
-
- Use the ClickedImageUrl property to specify the image that will be
- used when the user clicks the item. If the ClickedImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
-
- Gets or sets the path to an image to display when the item is disabled.
-
-
- The path to the image to display when the item is disabled. The
- default value is empty string.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/Img/inbox.gif"
- DisabledImageUrl="~/Img/inboxDisabled.gif" Text="Index" />
- </Items>
- </telerik:RadToolBar>
-
-
- Use the DisabledImageUrl property to specify the image that will be
- used when the item is disabled. If the DisabledImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the toolbar item is
- disabled.
-
-
- The CSS class applied when the toolbar item is disabled. The default value is
- String.Empty.
-
-
- By default the visual appearance of disabled toolbar items is defined in the skin CSS
- file. You can use the DisabledCssClass property to specify unique
- appearance for the toolbar item when it is disabled.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the toolBar item is
- focused after tabbing to it, or by using its AccessKey
-
-
- The CSS class applied when the toolBar item is focused. The default value is
- String.Empty.
-
-
-
- <style type="text/css">
- .myFocusedCssClass .rtbText
- {
- font-weight:bold !important;
- color:red !important;
- }
- </style>
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton
- FocusedCssClass="myFocusedCssClass" Text="Bold" />
- </Items>
- </telerik:RadToolBar>
-
-
- By default the visual appearance of focused toolBar items is defined in the skin CSS
- file. You can use the FocusedCssClass property to specify unique
- appearance for the toolBar item when it is focused.
-
-
-
-
- Gets or sets the path to an image to display when the user focuses the
- item either by tabbing to it or by using the AccessKey
-
-
- The path to the image to display when the user user focuses the
- item either by tabbing to that it or by using the AccessKey. The
- default value is empty string.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/Img/bold.gif"
- FocusedImageUrl="~/Img/boldFocused.gif" Text="Bold" />
- </Items>
- </telerik:RadToolBar>
-
-
- Use the FocusedImageUrl property to specify the image that will be
- used when the item gets the focus after tabbing or using its AccessKey.
- If the FocusedImageUrl property is set to empty string the image specified
- by the ImageUrl property will be used. Use "~" (tilde) when referring to
- images within the current ASP.NET application.
-
-
-
-
- Gets or sets the position of the item image according to the item text.
-
-
- The position of the item image according to the item text. The
- default value is ToolBarImagePosition.Left.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/Img/bold.gif"
- ImagePosition="Right" Text="Bold" />
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- For internal use only
-
-
-
-
-
- Initializes a new instance of the RadToolBarButton class.
-
- Use this constructor to create and initialize a new instance of the
- RadToolBarButton class using default values.
-
-
- The following example demonstrates how to add items to
- RadToolBar controls.
-
- RadToolBarButton button = new RadToolBarButton();
- button.Text = "Create New";
- button.CommandName = "CreateNew";
- button.ImageUrl = "~/ToolBarImages/CreateNew.gif";
-
- RadToolBar1.Items.Add(button);
-
-
- Dim button As New RadToolBarButton()
- button.Text = "Create New"
- button.CommandName = "CreateNew"
- button.ImageUrl = "~/ToolBarImages/CreateNew.gif"
-
- RadToolBar1.Items.Add(button)
-
-
-
-
-
- Initializes a new instance of the RadToolBarButton class with the
- specified text data.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadToolBarButton class using the specified text.
-
-
-
- The following example demonstrates how to add items to
- RadToolBar controls.
-
- RadToolBarButton button = new RadToolBarButton("Create New");
- button.CommandName = "CreateNew";
- button.ImageUrl = "~/ToolBarImages/CreateNew.gif";
-
- RadToolBar1.Items.Add(button);
-
-
- Dim button As New RadToolBarButton("Create New")
- button.CommandName = "CreateNew"
- button.ImageUrl = "~/ToolBarImages/CreateNew.gif"
-
- RadToolBar1.Items.Add(button)
-
-
-
- The text of the button. The Text property is set to the value
- of this parameter.
-
-
-
-
- Initializes a new instance of the RadToolBarButton class with the
- specified text, checked state and group name data.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadToolBarButton class using the specified text,
- checked state and group name.
-
-
- When this constructor used, the CheckOnClick property of the created
- RadToolBarButton is automatically set to true.
-
-
-
- The following example demonstrates how to add items to
- RadToolBar controls.
-
- RadToolBarButton alighLeftButton = new RadToolBarButton("Left", false, "Alignment");
- alighLeftButton.CommandName = "AlignLeft";
- alighLeftButton.ImageUrl = "~/ToolBarImages/AlignLeft.gif";
- RadToolBar1.Items.Add(alighLeftButton);
-
- RadToolBarButton alignCenterButton = new RadToolBarButton("Center", false, "Alignment");
- alignCenterButton.CommandName = "AlignCenter";
- alignCenterButton.ImageUrl = "~/ToolBarImages/AlignCenter.gif";
- RadToolBar1.Items.Add(alignCenterButton);
-
- RadToolBarButton alignRightButton = new RadToolBarButton("Right", false, "Alignment");
- alignRightButton.CommandName = "AlignRight";
- alignRightButton.ImageUrl = "~/ToolBarImages/AlignRight.gif";
- RadToolBar1.Items.Add(alignRightButton);
-
-
- Dim alighLeftButton As RadToolBarButton = New RadToolBarButton("Left", False, "Alignment")
- alighLeftButton.CommandName = "AlignLeft"
- alighLeftButton.ImageUrl = "~/ToolBarImages/AlignLeft.gif"
- RadToolBar1.Items.Add(alighLeftButton)
-
- Dim alignCenterButton As RadToolBarButton = New RadToolBarButton("Center", False, "Alignment")
- alignCenterButton.CommandName = "AlignCenter"
- alignCenterButton.ImageUrl = "~/ToolBarImages/AlignCenter.gif"
- RadToolBar1.Items.Add(alignCenterButton)
-
- Dim alignRightButton As RadToolBarButton = New RadToolBarButton("Right", False, "Alignment")
- alignRightButton.CommandName = "AlignRight"
- alignRightButton.ImageUrl = "~/ToolBarImages/AlignRight.gif"
- RadToolBar1.Items.Add(alignRightButton)
-
-
-
- The text of the button. The Text property is set to the value
- of this parameter.
-
-
- The checked state of the button. The Checked property is set to the value
- of this parameter.
-
-
- The group to which the button belongs. The Group property is set
- to the value of this parameter.
-
-
-
- Creates a copy of the current RadToolBarButton object.
- A RadToolBarButton which is a copy of the current one.
-
- Use the Clone method to create a copy of the current button. All
- properties of the clone are set to the same values as the current ones.
-
-
-
-
- Gets a reference to the owner of the RadToolBarButton.
-
-
- The IToolBarItemContainer control (RadToolBar,
- RadToolBarDropDown,
- RadToolBarSplitButton) which holds the RadToolBarButton.
-
-
-
- Gets the data item that is bound to the button
-
- An Object that represents the data item that is bound to the button. The default value is null
- (Nothing in Visual Basic), which indicates that the button is not bound to any data item. The
- return value will always be null unless accessed within a
- ButtonDataBound event handler.
-
-
- This property is applicable only during data binding. Use it along with the
- ButtonDataBound event to perform additional
- mapping of fields from the data item to RadToolBarButton properties.
-
-
- The following example demonstrates how to map fields from the data item to
- RadToolBarButton properties. It assumes the user has subscribed to the
- ButtonDataBound event.
-
- private void RadToolBar1_ButtonDataBound(object sender, Telerik.Web.UI.RadToolBarButtonEventArgs e)
- {
- e.Button.ImageUrl = "image" + (string)DataBinder.Eval(e.Button.DataItem, "ID") + ".gif";
- e.Button.NavigateUrl = (string)DataBinder.Eval(e.Button.DataItem, "URL");
- }
-
-
- Sub RadToolBar1_ButtonDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadToolBarButtonEventArgs) Handles RadToolBar1.ButtonDataBound
- e.Button.ImageUrl = "image" & DataBinder.Eval(e.Button.DataItem, "ID") & ".gif"
- e.Button.NavigateUrl = CStr(DataBinder.Eval(e.Button.DataItem, "URL"))
- End Sub
-
-
-
-
-
- Gets or sets whether the button is separator.
-
-
-
-
- Gets or sets whether the button has a check state.
-
-
-
-
- Gets or sets if the button is checked.
-
-
- The Checked property of the button depends on the
- CheckOnClick property. If the
- CheckOnClick property is set to
- false, the Checked property will be ignored.
-
- When a button's Checked state is set to true, all the buttons that belong
- to the same group in the RadToolBar get their Checked
- state set to false.
-
-
-
-
-
- Gets or sets the group to which the button belongs.
-
-
- The Group property of the button depends on the
- CheckOnClick property. When several buttons
- in the RadToolBar are assigned to the same group, checking one
- of them will uncheck the one that is currently checked. If the
- CheckOnClick property is set to
- false, the Group property will be ignored.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the toolbar button is
- checked.
-
-
- The CSS class applied when the toolbar button is checked. The default value is
- string.Empty.
-
-
- By default the visual appearance of clicked toolbar buttons is defined in the skin CSS
- file. You can use the ClickedCssClass property to specify unique
- appearance for the toolbar button when it is clicked.
-
-
-
-
- Gets or sets the path to an image to display for the button when its Checked state is "true".
-
-
- The path to the image to display when its Checked state is "true". The default value
- is empty string.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/Img/alignLeft.gif"
- CheckedImageUrl="~/Img/alignLeftChecked.gif" Text="Left" />
- <telerik:RadToolBarButton ImageUrl="~/Img/alignRight.gif"
- CheckedImageUrl="~/Img/alignRightChecked.gif" Text="Right"
- />
- </Items>
- </telerik:RadToolBar>
-
-
- Use the CheckedImageUrl property to specify the image that will be
- used when the button is checked. If the CheckedImageUrl
- property is set to empty string the image specified by the ImageUrl
- property will be used. Use "~" (tilde) when referring to images within the current
- ASP.NET application.
-
-
-
-
- Gets or sets a value indicating if a checked button will get unchecked when clicked.
-
-
- If a checked button will get unchecked when clicked. The default value is
- false.
-
-
-
- Gets or sets the template for displaying the button.
-
- A ITemplate implemented object that contains the template
- for displaying the item. The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
-
- The following template demonstrates how to add a Calendar control in a certain
- ToolBar button.
- ASPX:
- <telerik:RadToolBar runat="server" ID="RadToolBar1">
-
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets a value indicating whether clicking on the button will
- postback.
-
-
- True if the toolbar button should postback; otherwise
- false. By default all the items will postback provided the user
- has subscribed to the ButtonClick event.
-
-
- If you subscribe to the ButtonClick all toolbar
- buttons will postback. To turn off that behavior you should set the
- PostBack property to false.
-
-
-
- Gets or sets the value associated with the toolbar button.
- The value associated with the button. The default value is empty string.
-
- Use the Value property to specify or determine the value associated
- with the button.
-
-
-
- Gets or sets the URL to link to when the button is clicked.
-
- The URL to link to when the button is clicked. The default value is empty
- string.
-
-
- The following example demonstrates how to use the NavigateUrl
- property
-
- <telerik:RadToolBar id="RadToolBar1"
- runat="server">
- <Items>
- <telerik:RadToolBarButton Text="News" NavigateUrl="~/News.aspx"
- />
- <telerik:RadToolBarButton Text="External URL"
- NavigateUrl="http://www.example.com" />
- </Items>
- </telerik:RadToolBar>
-
-
-
- Use the NavigateUrl property to specify the URL to link to when
- the button is clicked. Use "~" (tilde) in front of an URL within the same ASP.NET
- application. When specifying external URL do not forget the protocol (e.g.
- "http://").
-
-
-
-
- Gets or sets the target window or frame to display the Web page content linked to
- when the toolbar button is clicked.
-
-
- The target window or frame to load the Web page linked to when the button is
- selected. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without
- frames.
-
-
- _parent
- Renders the content in the immediate frameset
- parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without
- frames.
-
-
- The default value is empty string.
-
-
-
- Use the Target property to specify the frame or window that displays the
- Web page linked to when the toolbar button is clicked. The Web page is specified by
- setting the NavigateUrl property.
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
- The following example demonstrates how to use the Target
- property
- ASPX:
- <telerik:RadToolBar runat="server" ID="RadToolBar1">
- <Items>
- <telerik:RadToolBarButton Target="_blank"
- NavigateUrl="http://www.google.com" />
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets the command name associated with the toolbar button that is passed to the
- ItemCommand event of the RadToolBar instance.
-
-
- The command name of the toolbar button. The default value is an empty string.
-
-
-
-
- Gets or sets an optional parameter passed to the Command event of the
- RadToolBar instance along with the associated
- CommandName
-
-
- An optional parameter passed to the Command event of the
- RadToolBar instance along with the associated
- CommandName. The default value is an empty string.
-
-
-
-
- Gets or sets a value indicating whether validation is performed when
- the RadToolBarButton is clicked
-
-
- true if validation is performed when the RadToolBarButton
- is clicked otherwise, false. The default value is true.
-
-
- By default, page validation is performed when the button is clicked. Page
- validation determines whether the input controls associated with a validation
- control on the page all pass the validation rules specified by the validation
- control. You can specify or determine whether validation is performed when the button is clicked
- on both the client and the server by using the CausesValidation
- property. To prevent validation from being performed, set the
- CausesValidation property to false.
-
-
-
-
- Gets or sets the name of the validation group to which the
- RadToolBarButton belongs.
-
-
- The name of the validation group to which this RadToolBarButton
- belongs. The default is an empty string (""), which indicates that this property is not set.
-
-
- This property works only when CausesValidation
- is set to true.
-
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when the
- RadToolBarButton is clicked.
-
-
- The URL of the Web page to post to from the current page when the
- RadToolBarButton is clicked. The default value is an empty
- string (""), which causes the page to post back to itself.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a dropdown in the RadToolBar class.
-
-
- Initializes a new instance of the RadToolBarDropDown class.
-
- Use this constructor to create and initialize a new instance of the
- RadToolBarDropDown class using default values.
-
-
- The following example demonstrates how to add items to
- RadToolBar controls.
-
- RadToolBarDropDown dropdown = new RadToolBarDropDown();
- dropdown.Text = "Manage";
- dropdown.ImageUrl = "~/ToolbarImages/Manage.gif";
-
- RadToolBar1.Items.Add(dropdown);
-
-
- Dim dropdown As New RadToolBarDropDown()
- dropdown.Text = "Manage"
- dropdown.ImageUrl = "~/ToolbarImages/Manage.gif"
-
- RadToolBar1.Items.Add(dropdown)
-
-
-
-
-
- Initializes a new instance of the RadToolBarDropDown class with the
- specified text data.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadToolBarDropDown class using the specified text.
-
-
-
- The following example demonstrates how to add items to
- RadToolBar controls.
-
- RadToolBarDropDown dropdown = new RadToolBarDropDown("Manage");
-
- RadToolBar1.Items.Add(dropdown);
-
-
- Dim dropdown As New RadToolBarDropDown("Manage")
-
- RadToolBar1.Items.Add(dropdown)
-
-
-
- The text of the dropdown. The Text property is set to the value
- of this parameter.
-
-
-
-
- Gets a RadToolBarButtonCollection object that
- contains the child buttons of the dropdown.
-
-
- A RadToolBarButtonCollection that contains the
- child buttons of the dropdown. By default the collection is empty (the dropdown has no buttons).
-
-
- Use the Buttons property to access the child buttons of the dropdown. You can also use
- the Buttons property to manage the children of the dropdown. You can add,
- remove or modify buttons from the Buttons collection.
-
-
- The following example demonstrates how to programmatically modify the properties of child buttons.
-
- manageDropDown.Buttons[0].Text = "Users";
- manageDropDown.Buttons[0].ImageUrl = "~/ToolbarImages/ManageUsers.gif";
-
-
- manageDropDown.Buttons[0].Text = "Users"
- manageDropDown.Buttons[0].ImageUrl = "~/ToolbarImages/ManageUsers.gif"
-
-
-
-
-
- Gets or sets the expand direction of the drop down.
-
-
- The expand direction of the drop down. The
- default value is ToolBarDropDownExpandDirection.Down.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarDropDown ImageUrl="~/Img/bold.gif"
- ExpandDirection="Up" Text="Bold" />
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets the width of the dropdown in pixels.
-
-
-
-
- Gets or sets the height of the dropdown in pixels.
-
-
-
-
-
-
-
- Represents a splitbutton in the RadToolBar class.
-
-
- Initializes a new instance of the RadToolBarSplitButton class.
-
- Use this constructor to create and initialize a new instance of the
- RadToolBarSplitButton class using default values.
-
-
- The following example demonstrates how to add items to
- RadToolBar controls.
-
- RadToolBarSplitButton splitButton = new RadToolBarSplitButton();
- splitButton.Text = "News";
- splitButton.ImageUrl = "~/News.gif";
-
- RadToolBar1.Items.Add(splitButton);
-
-
- Dim splitButton As New RadToolBarSplitButton()
- splitButton.Text = "News"
- splitButton.ImageUrl = "~/News.gif"
-
- RadToolBar1.Items.Add(splitButton)
-
-
-
-
-
- Initializes a new instance of the RadToolBarSplitButton class with the
- specified text data.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadToolBarSplitButton class using the specified text.
-
-
-
- The following example demonstrates how to add items to
- RadToolBar controls.
-
- RadToolBarSplitButton splitButton = new RadToolBarSplitButton("News");
-
- RadToolBar1.Items.Add(splitButton);
-
-
- Dim splitButton As New RadToolBarSplitButton("News")
-
- RadToolBar1.Items.Add(splitButton)
-
-
-
- The text of the split button. The Text property is set to the value
- of this parameter.
-
-
-
-
- Gets a RadToolBarButtonCollection object that
- contains the child buttons of the split button.
-
-
- A RadToolBarButtonCollection that contains the
- child buttons of the split button. By default the collection is empty (the split button has
- no buttons).
-
-
- Use the Buttons property to access the child buttons of the split button.
- You can also use the Buttons property to manage the children of the
- current tab. You can add, remove or modify buttons from the Buttons collection.
-
-
- The following example demonstrates how to programmatically modify the properties of child buttons.
-
- registerPurchaseSplitButton.Buttons[0].Text = "Cache Purchase";
- registerPurchaseSplitButton.Buttons[0].ImageUrl = "~/ToolBarImages/RegisterCachePurchase.gif";
-
- registerPurchaseSplitButton.Buttons[1].Text = "Check Purchase";
- registerPurchaseSplitButton.Buttons[1].ImageUrl = "~/ToolBarImages/RegisterCheckPurchase.gif";
-
-
- registerPurchaseSplitButton.Buttons[0].Text = "Cache Purchase"
- registerPurchaseSplitButton.Buttons[0].ImageUrl = "~/ToolBarImages/RegisterCachePurchase.gif"
-
- registerPurchaseSplitButton.Buttons[1].Text = "Check Purchase"
- registerPurchaseSplitButton.Buttons[1].ImageUrl = "~/ToolBarImages/RegisterCheckPurchase.gif"
-
-
-
-
-
- Gets or sets the expand direction of the drop down.
-
-
- The expand direction of the drop down. The
- default value is ToolBarDropDownExpandDirection.Down.
-
-
- <telerik:RadToolBar id="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarDropDown ImageUrl="~/Img/bold.gif"
- ExpandDirection="Up" Text="Bold" />
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets the width of the dropdown in pixels.
-
-
-
-
- Gets or sets the height of the dropdown in pixels.
-
-
-
- Gets or sets a value, indicating if the RadToolBarSplitButton will
- use the DefaultButton behavior.
-
- A value, indicating if the RadToolBarSplitButton wll
- use the DefaultButton behavior. The default value is true
-
-
- Use the EnableDefaultButton property to set if
- RadToolBarSplitButton will use the DefaultButton
- behavior or not. When the DefaultButton behavior is used, the
- RadToolBarSplitButton properties are ignored and the
- properties of the last selected button are used instead. Use the EnableDefaultButton
- property in conjunction with the DefaultButtonIndex property to
- specify which of the RadToolBarSplitButton child buttons will
- be used when the RadToolBar is initially displayed.
-
-
- The following example demonstrates how to use the EnableDefaultButton
- property
-
- <telerik:RadToolBar id="RadToolBar1"
- runat="server">
- <Items>
- <telerik:RadToolBarSplitButton EnableDefaultButton="true"
- DefaultButtonIndex="1">
- <Buttons>
- <telerik:RadToolBarButton ImageUrl="~/images/red.gif" Text="Red" />
- <telerik:RadToolBarButton ImageUrl="~/images/green.gif" Text="Green" />
- <telerik:RadToolBarButton ImageUrl="~/images/blue.gif" Text="Blue" />
- </Buttons>
- </telerik:RadToolBarSplitButton>/
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets the index of the button which properties will be used by default when the
- EnableDefaultButton property set to true.
-
- The index of the button which properties will be used by default when the
- EnableDefaultButton property set to true.
- The default value is 0
-
-
- Use the DefaultButtonIndex property to specify the button
- which properties RadToolBarSplitButton will use
- when the RadToolBar is initially displayed.
-
-
- The following example demonstrates how to use the DefaultButtonIndex
- property
-
- <telerik:RadToolBar id="RadToolBar1"
- runat="server">
- <Items>
- <telerik:RadToolBarSplitButton EnableDefaultButton="true"
- DefaultButtonIndex="1">
- <Buttons>
- <telerik:RadToolBarButton ImageUrl="~/images/red.gif" Text="Red" />
- <telerik:RadToolBarButton ImageUrl="~/images/green.gif" Text="Green" />
- <telerik:RadToolBarButton ImageUrl="~/images/blue.gif" Text="Blue" />
- </Buttons>
- </telerik:RadToolBarSplitButton>/
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets the template for displaying the button.
-
- A ITemplate implemented object that contains the template
- for displaying the button. The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
-
- The following template demonstrates how to add a Calendar control in a certain
- ToolBar button.
- ASPX:
- <telerik:RadToolBar runat="server" ID="RadToolBar1">
-
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets a value indicating whether clicking on the button will
- postback.
-
-
- True if the toolbar split button should postback; otherwise
- false. By default all the items will postback provided the user
- has subscribed to the ButtonClick event.
-
-
- If you subscribe to the ButtonClick all toolbar
- buttons will postback. To turn off that behavior you should set the
- PostBack property to false.
-
-
-
- Gets or sets the value associated with the toolbar split button.
- The value associated with the button. The default value is empty string.
-
- Use the Value property to specify or determine the value associated
- with the button.
-
-
-
- Gets or sets the URL to link to when the button is clicked.
-
- The URL to link to when the button is clicked. The default value is empty
- string.
-
-
- The following example demonstrates how to use the NavigateUrl
- property
-
- <telerik:RadToolBar id="RadToolBar1"
- runat="server">
- <Items>
- <telerik:RadToolBarSplitButton Text="News" NavigateUrl="~/News.aspx"
- ImageUrl="~/Img/News.gif">
- <Buttons>
- <telerik:RadToolBarButton Text="Button1" />
- </Buttons>
- </telerik:RadToolBarSplitButton>/
- <telerik:RadToolBarButton Text="News" NavigateUrl="~/News.aspx"
- />
- <telerik:RadToolBarButton Text="External URL"
- NavigateUrl="http://www.example.com" />
- </Items>
- </telerik:RadToolBar>
-
-
-
- Use the NavigateUrl property to specify the URL to link to when
- the button is clicked. Use "~" (tilde) in front of an URL within the same ASP.NET
- application. When specifying external URL do not forget the protocol (e.g.
- "http://").
-
-
-
-
- Gets or sets the target window or frame to display the Web page content linked to
- when the toolbar button is clicked.
-
-
- The target window or frame to load the Web page linked to when the button is
- selected. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without
- frames.
-
-
- _parent
- Renders the content in the immediate frameset
- parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without
- frames.
-
-
- The default value is empty string.
-
-
-
- Use the Target property to specify the frame or window that displays the
- Web page linked to when the toolbar button is clicked. The Web page is specified by
- setting the NavigateUrl property.
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
- The following example demonstrates how to use the Target
- property
- ASPX:
- <telerik:RadToolBar runat="server" ID="RadToolBar1">
- <Items>
- <telerik:RadToolBarSplitButton Text="News" NavigateUrl="~/News.aspx"
- Target="_blank" ImageUrl="~/Img/News.gif">
- <Buttons>
- <telerik:RadToolBarButton Text="Button1" />
- </Buttons>
- </telerik:RadToolBarSplitButton>/
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets the command name associated with the toolbar button that is passed to the
- ItemCommand event of the RadToolBar instance.
-
-
- The command name of the toolbar button. The default value is an empty string.
-
-
-
-
- Gets or sets an optional parameter passed to the Command event of the
- RadToolBar instance along with the associated
- CommandName
-
-
- An optional parameter passed to the Command event of the
- RadToolBar instance along with the associated
- CommandName. The default value is an empty string.
-
-
-
-
- Gets or sets a value indicating whether validation is performed when
- the RadToolBarSplitButton is clicked
-
-
- true if validation is performed when the
- RadToolBarSplitButton is clicked otherwise, false.
- The default value is true.
-
-
- By default, page validation is performed when the button is clicked. Page
- validation determines whether the input controls associated with a validation
- control on the page all pass the validation rules specified by the validation
- control. You can specify or determine whether validation is performed when the button is clicked
- on both the client and the server by using the CausesValidation
- property. To prevent validation from being performed, set the
- CausesValidation property to false.
-
-
-
-
- Gets or sets the name of the validation group to which the
- RadToolBarSplitButton belongs.
-
-
- The name of the validation group to which this RadToolBarSplitButton
- belongs. The default is an empty string (""), which indicates that this property is not set.
-
-
- This property works only when CausesValidation
- is set to true.
-
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when the
- RadToolBarSplitButton is clicked.
-
-
- The URL of the Web page to post to from the current page when the
- RadToolBarSplitButton is clicked. The default value is an empty
- string (""), which causes the page to post back to itself.
-
-
-
-
-
-
-
-
-
-
-
-
- RadToolBar control class.
-
-
-
-
- Populates the RadToolBar control from external XML file.
-
-
- The newly added items will be appended after any existing ones.
-
-
- The following example demonstrates how to populate RadToolBar control
- from XML file.
-
- private void Page_Load(object sender, EventArgs e)
- {
- if (!Page.IsPostBack)
- {
- RadToolBar1.LoadContentFile("~/ToolBarData.xml");
- }
- }
-
-
- Private Sub Page_Load(sender As Object, e As EventArgs) Handles MyBase.Load
- If Not Page.IsPostBack Then
- RadToolBar1.LoadContentFile("~/ToolBarData.xml")
- End If
- End Sub
-
-
- The name of the XML file.
-
-
-
- Gets a linear list of all toolbar items in the RadToolBar control.
-
-
- An IList object containing
- all items in the current RadToolBar control.
-
-
-
-
- Gets a linear list of all toolbar buttons in the RadToolBar control,
- which belong to the specified group
-
- The name of the group to search for.
- An IList object containing
- all the buttons in the current RadToolBar control, which belong to the specified group.
-
-
-
-
- Gets the checked button which belongs to the specified group in the
- RadToolBar control
-
- The name of the group to search for.
- A RadToolBarButton object which
- CheckOnClick and Checked properties are set to true.
-
-
-
-
- Searches the RadToolBar control for the first
- RadToolBarItem whose Text
- property is equal to the specified value.
-
-
- A RadToolBarItem whose Text
- property is equal to the specified value. If an item is not found, null
- (Nothing in Visual Basic) is returned.
-
- The value to search for.
-
-
-
- Searches the RadToolBar control for the first
- RadToolBarItem whose Text
- property is equal to the specified value.
-
-
- A RadToolBarItem whose Text
- property is equal to the specified value. If an item is not found, null
- (Nothing in Visual Basic) is returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadToolBar control for the first
- RadToolBarButton or
- RadToolBarSplitButton which
- Value
- property is equal to the specified value.
-
-
- A RadToolBarButton or
- RadToolBarSplitButton which
- Value
- property is equal to the specified value. If an item is not found, null
- (Nothing in Visual Basic) is returned.
-
- The value to search for.
-
-
-
- Searches the RadToolBar control for the first
- RadToolBarButton or
- RadToolBarSplitButton which
- Value
- property is equal to the specified value.
-
-
- A RadToolBarButton or
- RadToolBarSplitButton which
- Value
- property is equal to the specified value. If an item is not found, null
- (Nothing in Visual Basic) is returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadToolBar control for the first
- RadToolBarButton or
- RadToolBarSplitButton which
- NavigateUrl
- property is equal to the specified value.
-
-
- A RadToolBarButton or
- RadToolBarSplitButton which
- NavigateUrl
- property is equal to the specified value. If an item is not found, null
- (Nothing in Visual Basic) is returned.
-
- The url to search for.
-
-
-
- Searches the RadToolBar control for the first
- IRadToolBarButton
- CommandName
- property is equal to the specified value.
-
-
- A IRadToolBarButton which
- CommandName
- property is equal to the specified value. If an item is not found, null
- (Nothing in Visual Basic) is returned.
-
- The commandName to search for.
-
-
-
- Returns the first RadToolBarItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadToolBar1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadToolBarItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadToolBar1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadToolBarItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Gets a list of all client-side changes (adding an item, removing an item, changing an item's property) which have occurred.
-
-
- A list of objects which represent all client-side changes the user has performed.
- By default the ClientChanges property returns empty list. Client-changes are recorded if and only if the client-side
- methods trackChanges()/commitChanges() have been invoked.
-
-
- You can use the ClientChanges property to respond to client-side modifications such as
-
- adding a new item
- removing existing item
- clearing the children of an item or the control itself
- changing a property of the item
-
- The ClientChanges property is available in the first postback (ajax) request after the client-side modifications
- have taken place. After this moment the property will return empty list.
-
-
- The following example demonstrates how to use the ClientChanges property
-
- foreach (ClientOperation<RadToolBarItem> operation in RadToolBar1.ClientChanges)
- {
- RadToolBarItem item = operation.Item;
-
- switch (operation.Type)
- {
- case ClientOperationType.Insert:
- //An item has been inserted - operation.Item contains the inserted item
- break;
- case ClientOperationType.Remove:
- //An item has been inserted - operation.Item contains the removed item.
- //Keep in mind the item has been removed from the toolbar.
- break;
- case ClientOperationType.Update:
- UpdateClientOperation<RadToolBarItem> update = operation as UpdateClientOperation<RadToolBarItem>
- //The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- break;
- case ClientOperationType.Clear:
- //All children of have been removed - operation.Item contains the parent item whose children have been removed. If operation.Item is null then the root items have been removed.
- break;
- }
- }
-
-
- For Each operation As ClientOperation(Of RadToolBarItem) In RadToolBar1.ClientChanges
- Dim item As RadToolBarItem = operation.Item
- Select Case operation.Type
- Case ClientOperationType.Insert
- 'An item has been inserted - operation.Item contains the inserted item
- Exit Select
- Case ClientOperationType.Remove
- 'An item has been inserted - operation.Item contains the removed item.
- 'Keep in mind the item has been removed from the toolbar.
- Exit Select
- Case ClientOperationType.Update
- Dim update As UpdateClientOperation(Of RadToolBarItem) = TryCast(operation, UpdateClientOperation(Of RadToolBarItem))
- 'The "UpdateOperation" provides an additional property "PropertyName". This is the property whose value was changed from the client side.
- Exit Select
- Case ClientOperationType.Clear
- 'All children of have been removed - operation.Item contains the parent item whose children have been removed. If operation.Item is Nothing then the root items have been removed.
- Exist Select
- End Select
- Next
-
-
-
-
-
- Gets a collection of RadToolBarItem objects representing
- the individual items within the RadToolBar.
-
-
- A RadToolBarItemCollection that contains a collection of
- RadToolBarItem objects representing
- the individual items within the RadToolBar.
-
-
- Use the Items collection to programmatically control the items in the
- RadToolBar control.
-
-
- The following example demonstrates how to declare a RadToolBar
- with different items.
-
- <telerik:RadToolBar ID="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/CreateNew.gif"
- Text="Create new" CommandName="CreateNew"/>
- <telerik:RadToolBarButton IsSeparator="true" />
- <telerik:RadToolBarDropDown ImageUrl="~/ToolbarImages/Manage.gif" Text="Manage">
- <Buttons>
- <telerik:RadToolBarButton ImageUrl="~/ToolbarImages/ManageUsers.gif"
- Text="Users" />
- <telerik:RadToolBarButton ImageUrl="~/ToolbarImages/ManageOrders.gif"
- Text="Orders" />
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton ImageUrl="~/ToolBarImages/RegisterPurchase.gif"
- Text="Register Purchase">
- <Buttons>
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/RegisterCachePurchase.gif"
- Text="Cache Purchase" />
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/RegisterCheckPurchase.gif"
- Text="Check Purchase" />
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/RegisterDirectBankPurchase.gif"
- Text="Bank Purchase" />
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets the direction in which to render the RadToolBar control.
-
-
- One of the Orientation enumeration values. The default is Orientation.Horizontal.
-
-
- Use the Orientation property to specify the direction in which to render the RadToolBar
- control. The following table lists the available directions.
-
-
-
- Orientation
- Description
-
-
- Orientation.Horizontal
- The RadToolBar control is rendered horizontally.
-
-
- Orientation.Vertical
- The RadToolBar control is rendered vertically.
-
-
-
-
-
- The following example demonstrates how to use the Orientation property
- to display a vertical RadToolBar.
-
- <telerik:RadToolBar ID="RadToolBar1" runat="server">
- <Items>
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/CreateNew.gif"
- Text="Create new" CommandName="CreateNew"/>
- <telerik:RadToolBarButton IsSeparator="true" />
- <telerik:RadToolBarDropDown ImageUrl="~/ToolbarImages/Manage.gif" Text="Manage">
- <Buttons>
- <telerik:RadToolBarButton ImageUrl="~/ToolbarImages/ManageUsers.gif"
- Text="Users" />
- <telerik:RadToolBarButton ImageUrl="~/ToolbarImages/ManageOrders.gif"
- Text="Orders" />
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton ImageUrl="~/ToolBarImages/RegisterPurchase.gif"
- Text="Register Purchase">
- <Buttons>
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/RegisterCachePurchase.gif"
- Text="Cache Purchase" />
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/RegisterCheckPurchase.gif"
- Text="Check Purchase" />
- <telerik:RadToolBarButton ImageUrl="~/ToolBarImages/RegisterDirectBankPurchase.gif"
- Text="Bank Purchase" />
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets the settings for the animation played when a dropdown opens.
-
- An AnnimationSettings that represents the
- expand animation.
-
-
-
- Use the ExpandAnimation property to customize the expand
- animation of the RadToolBar dropdown items -
- RadToolBarDropDown and
- RadToolBarSplitButton. You can specify the
- Type and
- the Duration of the expand animation.
- To disable expand animation effects you should set the
- Type to
- AnimationType.None.
- To customize the collapse animation you can use the
- CollapseAnimation property.
-
-
-
- The following example demonstrates how to set the ExpandAnimation
- of the RadToolBar dropdown items.
-
- ASPX:
-
-
- <telerik:RadToolBar ID="RadToolBar1" runat="server">
- <ExpandAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadToolBarDropDown Text="Insert Html Element" >
- <Buttons>
- <telerik:RadToolBarButton Text="Image" />
- <telerik:RadToolBarButton Text="Editable Div element" />
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Insert Form Element" >
- <Buttons>
- <telerik:RadToolBarButton Text="Button" />
- <telerik:RadToolBarButton Text="TextBox" />
- <telerik:RadToolBarButton Text="TextArea" />
- <telerik:RadToolBarButton Text="CheckBox" />
- <telerik:RadToolBarButton Text="RadioButton" />
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadToolBar1.ExpandAnimation.Type = AnimationType.Linear;
- RadToolBar1.ExpandAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadToolBar1.ExpandAnimation.Type = AnimationType.Linear
- RadToolBar1.ExpandAnimation.Duration = 300
- End Sub
-
-
-
-
- Gets the settings for the animation played when a dropdown closes.
-
- An AnnimationSettings that represents the
- collapse animation.
-
-
-
- Use the CollapseAnimation property to customize the collapse
- animation of the RadToolBar dropdown items -
- RadToolBarDropDown and
- RadToolBarSplitButton. You can specify the
- Type and
- the Duration of the collapse animation.
- To disable collapse animation effects you should set the
- Type to
- AnimationType.None.
- To customize the expand animation you can use the
- ExpandAnimation property.
-
-
-
- The following example demonstrates how to set the CollapseAnimation
- of the RadToolBar dropdown items.
-
- ASPX:
-
-
- <telerik:RadToolBar ID="RadToolBar1" runat="server">
- <CollapseAnimation Type="OutQuint" Duration="300"
- />
- <Items>
- <telerik:RadToolBarDropDown Text="Insert Html Element" >
- <Buttons>
- <telerik:RadToolBarButton Text="Image" />
- <telerik:RadToolBarButton Text="Editable Div element" />
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Insert Form Element" >
- <Buttons>
- <telerik:RadToolBarButton Text="Button" />
- <telerik:RadToolBarButton Text="TextBox" />
- <telerik:RadToolBarButton Text="TextArea" />
- <telerik:RadToolBarButton Text="CheckBox" />
- <telerik:RadToolBarButton Text="RadioButton" />
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
- void Page_Load(object sender, EventArgs e)
- {
- RadToolBar1.CollapseAnimation.Type = AnimationType.Linear;
- RadToolBar1.CollapseAnimation.Duration = 300;
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
- RadToolBar1.CollapseAnimation.Type = AnimationType.Linear
- RadToolBar1.CollapseAnimation.Duration = 300
- End Sub
-
-
-
-
-
- Gets or sets the name of the validation group to which this validation
- control belongs.
-
-
- The name of the validation group to which this validation control belongs. The
- default is an empty string (""), which indicates that this property is not set.
-
-
- This property works only when CausesValidation
- is set to true.
-
-
-
-
-
- Gets or sets the URL of the page to post to from the current page when a button item
- from the RadToolBar control is clicked.
-
-
- The URL of the Web page to post to from the current page when a tab from the
- tabstrip control is clicked. The default value is an empty string (""), which causes
- the page to post back to itself.
-
-
-
-
- Gets or sets a value indicating whether validation is performed when a button item within
- the RadToolBar control is clicked.
-
-
- true if validation is performed when a button item is clicked;
- otherwise, false. The default value is true.
-
-
- By default, page validation is performed when a button item is clicked. Page
- validation determines whether the input controls associated with a validation
- control on the page all pass the validation rules specified by the validation
- control. You can specify or determine whether validation is performed on both the
- client and the server when a tab is clicked by using the CausesValidation
- property. To prevent validation from being performed, set the
- CausesValidation property to false.
-
-
-
-
- Gets or sets a value indicating whether button items should postback when clicked.
-
-
- True if button items should postback; otherwise false. The default
- value is false.
-
-
- RadToolBar will postback provided one of the following conditions is met:
-
-
- The AutoPostBack property is set to true.
-
-
- The user has subscribed to the ButtonClick event.
-
-
-
-
-
-
- Gets or sets the name of the javascript function called when the control is fully
- initialized on the client side.
-
-
- A string specifying the name of the javascript function called when the control
- is fully initialized on the client side. The default value is empty string.
-
-
- Use the OnClientLoad property to specify a JavaScript
- function that is executed after the control is initialized on the client side.
- A single parameter is passed to the handler, which is the
- client-side RadToolBar object.
-
-
- The following example demonstrates how to use the OnClientLoad
- property.
-
- <script language="javascript">
- function onClientToolBarLoad(toolBar, eventArgs)
- {
- alert(toolBar.get_id() + " is loaded.");
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientButtonClicking="onButtonClicking">
- <Items>
- <telerik:RadToolBarButton Text="Save"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Load"></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Apply Color (Red)">
- <Buttons>
- <telerik:RadToolBarButton Text="Red"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Yellow"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Blue"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called just
- prior to clicking a toolbar button item (RadToolBarButton or RadToolBarSplitButton).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientButtonClicking property to specify a
- JavaScript function that will be executed prior to button item clicking - either by
- left-clicking it with the mouse or hitting enter after tabbing to that button. You can
- cancel that event (prevent button clicking) by seting the cancel property of the event argument to true.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with three properties
-
-
item - the instance of the button item being clicked
-
cancel - whether to cancel the event
-
domEvent - the reference to the browser DOM event
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientButtonClicking property.
-
- <script language="javascript">
- function clientButtonClicking(sender, eventArgs)
- {
- var toolBar = sender;
- var button = eventArgs.get_item();
-
- alert("You are clicking the '" + button.get_text() + "' button in the '" + toolBar.get_id() +
- "' toolBar.");
-
- if (button.get_text() == "Right")
- {
- alert("Right alignment is not available");
- eventArgs.set_cancel(true);
- }
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientButtonClicking="clientButtonClicking">
- <Items>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Right">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- after clicking a button item (RadToolBarButton or RadToolBarSplitButton).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientButtonClicked property to specify a JavaScript
- function that will be executed after a button is clicked - either by left-clicking it
- with the mouse or hitting enter after tabbing to that button item.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with two properties
-
-
item - the instance of the clicked button
-
domEvent - the reference to the browser DOM event
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientButtonClicked property.
-
- <script language="javascript">
- function clientButtonClicked(sender, eventArgs)
- {
- var toolBar = sender;
- var button = eventArgs.get_item();
-
- alert(String.format("You clicked the '{0}' button in the '{1}' toolBar.",
- button.get_text(), toolBar.get_id()));
- }
- </script>
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientButtonClicked="clientButtonClicked">
- <Items>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Right">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called just
- prior to opening a toolbar dropdown item (RadToolBarDropDown or RadToolBarSplitButton).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientDropDownOpening property to specify a
- JavaScript function that will be executed prior to dropdown item opening - either by
- left-clicking it with the mouse or hitting the down arrow after tabbing to that item. You can
- cancel that event (prevent dropdown opening) by seting the cancel property of the event argument to true.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with three properties
-
-
item - the instance of the dropdown item being opened
-
cancel - whether to cancel the event
-
domEvent - the reference to the browser DOM event (null if the event was initiated by
- calling a client-side method such as dropDownItem.showDropDown();)
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientDropDownOpening property.
-
- <script language="javascript">
- function clientDropDownOpening(sender, eventArgs)
- {
- var toolBar = sender;
- var dropDownItem = eventArgs.get_item();
-
- alert("You are opening the '" + dropDownItem.get_text() + "' dropDown in the '" + toolBar.get_id() +
- "' toolBar.");
-
- if (dropDownItem.get_text() == "Align")
- {
- alert("Alignment is not available");
- eventArgs.set_cancel(true);
- }
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientDropDownOpening="clientDropDownOpening">
- <Items>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Right">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called after a
- toolbar dropdown item (RadToolBarDropDown or RadToolBarSplitButton) is opened.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientDropDownOpened property to specify a
- JavaScript function that will be executed after a toolbar dropdown item
- is opened - either by left-clicking it with the mouse or hitting the down arrow
- after tabbing to that item.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with two properties
-
-
item - the instance of the dropdown item which is opened
-
domEvent - the reference to the browser DOM event (null if the event was initiated by
- calling a client-side method such as dropDownItem.showDropDown())
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientDropDownOpened property.
-
- <script language="javascript">
- function clientDropDownOpened(sender, eventArgs)
- {
- var toolBar = sender;
- var dropDownItem = eventArgs.get_item();
-
- alert("You just opened the '" + dropDownItem.get_text() + "' dropDown in the '" + toolBar.get_id() +
- "' toolBar.");
-
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientDropDownOpened="clientDropDownOpened">
- <Items>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Right">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called just
- prior to closing a toolbar dropdown item (RadToolBarDropDown or RadToolBarSplitButton).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientDropDownClosing property to specify a
- JavaScript function that will be executed prior to dropdown item closing - either by
- left-clicking an open dropdown with the mouse, hitting the ESC key when the dropdown or
- a button in it is focused, or clicking a non-checkable button in the dropdown. You can
- cancel that event (prevent dropdown closing) by seting the cancel property of the event argument to true.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with three properties
-
-
item - the instance of the dropdown item being closed
-
cancel - whether to cancel the event
-
domEvent - the reference to the browser DOM event (null if the event was initiated by
- calling a client-side method such as dropDownItem.hideDropDown())
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientDropDownClosing property.
-
- <script language="javascript">
- function clientDropDownClosing(sender, eventArgs)
- {
- var toolBar = sender;
- var dropDownItem = eventArgs.get_item();
-
- alert("You are about to close the '" + dropDownItem.get_text() + "' dropDown in the '" + toolBar.get_id() +
- "' toolBar.");
-
- if (dropDownItem.get_text() == "Align")
- {
- alert("You cannot close the Align dropdown!");
- eventArgs.set_cancel(true);
- }
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientDropDownClosing="clientDropDownClosing">
- <Items>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Right">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called after a
- toolbar dropdown item (RadToolBarDropDown or RadToolBarSplitButton) is closed.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientDropDownClosed property to specify a
- JavaScript function that will be executed after a toolbar dropdown item
- is closed - either by left-clicking an open dropdown with the mouse, hitting
- the ESC key when the dropdown or a button in it is focused, or clicking a
- non-checkable button in the dropdown.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with two properties
-
-
item - the instance of the dropdown item which is closed
-
domEvent - the reference to the browser DOM event (null if the event was initiated by
- calling a client-side method such as dropDownItem.hideDropDown())
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientDropDownClosed property.
-
- <script language="javascript">
- function clientDropDownClosed(sender, eventArgs)
- {
- var toolBar = sender;
- var dropDownItem = eventArgs.get_item();
-
- alert("You just closed the '" + dropDownItem.get_text() + "' dropDown in the '" + toolBar.get_id() +
- "' toolBar.");
-
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientDropDownClosed="clientDropDownClosed">
- <Items>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Right">
- <Buttons>
- <telerik:RadToolBarButton Text="Left"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right"></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called
- before the browser context menu shows (after right-clicking an item).
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientContextMenu property to specify a JavaScript
- function that will be executed before the context menu shows after right clicking an
- item.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with two properties
-
-
item - the instance of the selected toolbar item
-
domEvent - the reference to the browser DOM event
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientContextMenu property.
-
- <script language="javascript">
- function onContextMenuHandler(sender, eventArgs)
- {
- var toolBar = sender;
- var item = eventArgs.get_item();
-
- alert(String.format("You have right-clicked the {0} item in the {1} toolBar.", item.get_text(), toolBar.get_id());
- }
- </script>
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientContextMenu="onContextMenuHandler">
- <Items>
- <telerik:RadToolBarButton Text="Bold"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Italic"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Underline"></telerik:RadToolBarButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse hovers an item in the RadToolBar control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientMouseOver property to specify a JavaScript
- function that is called when the user hovers an item with the mouse.
- Two parameters are passed to the handler:
-
- sender (the client-side RadToolBar object);
-
- eventArgs with two properties
-
-
item - the instance of the toolbar item that is being hovered
-
domEvent - the reference to the browser DOM event
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientMouseOver property.
-
- <script language="javascript">
- function onClientMouseOver(sender, eventArgs)
- {
- var toolBar = sender;
- var item = eventArgs.get_item();
- var domEvent = eventArgs.get_domEvent();
-
- alert(String.format("You have just moved over the {0} item in the {1} toolBar", item.get_text(), toolBar.get_id());
- alert(String.format("Mouse coordinates: \n\nx = {0};\ny = {1}", domEvent.clientX, domEvent.clientY));
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientMouseOver="onClientMouseOver">
- <Items>
- <telerik:RadToolBarButton Text="Bold"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Italic"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Underline"></telerik:RadToolBarButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called when
- the mouse leaves an item in the RadToolBar control.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientMouseOut property to specify a JavaScript
- function that is executed whenever the user moves the mouse
- away from a particular item in the RadToolBar control.
- Two parameters are passed to the handler:
-
- sender (the client-side RadToolBar object);
-
- eventArgs with two properties:
-
-
item - the instance of the item which the mouse is moving
- away from;
-
domEvent - the reference to the browser DOM event
-
-
-
-
-
- The following example demonstrates how to use the OnClientMouseOut
- property.
-
- <script language="javascript">
- function onClientMouseOut(sender, eventArgs)
- {
- var toolBar = sender;
- var item = eventArgs.get_item();
- var domEvent = eventArgs.get_domEvent();
- alert(String.format("You have just moved out of '{0}' item in the {1} toolBar.",
- item.get_text(), toolBar.get_id()));
- alert(String.format("Mouse coordinates: \n\nx = {0}\ny = {1}",
- domEvent.clientX, domEvent.clientY));
- }
- </script>
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientMouseOut="onClientMouseOut">
- <Items>
- <telerik:RadToolBarButton Text="Bold"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Italic"></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Underline"></telerik:RadToolBarButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called just
- prior to changing the state of a checkable RadToolBarButton.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientCheckedStateChanging property to specify a
- JavaScript function that will be executed prior to button checked state changing - either by
- left-clicking a checkable button or pressing the ENTER key after tabbing to that button. You can
- cancel that event (prevent button checked state changing) by seting the cancel property of the
- event argument to true.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with three properties
-
-
item - the instance of the button which checked state is being changed
-
cancel - whether to cancel the event
-
domEvent - the reference to the browser DOM event (null if the event was initiated by
- calling a client-side method such as button.toggle())
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientCheckedStateChanging property.
-
- <script language="javascript">
- function clientCheckedStateChanging(sender, eventArgs)
- {
- var toolBar = sender;
- var button = eventArgs.get_item();
-
- alert(String.format("You are about to change the checked state of the '{0}' button in the '{1}' toolBar.",
- button.get_text(), toolBar.get_id()));
-
- if (item.get_text() == "Left" && item.get_group() == "Align")
- {
- alert("You cannot change the checked state of the 'Align Left' button!");
- eventArgs.set_cancel(true);
- }
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientCheckedStateChanging="clientCheckedStateChanging">
- <Items>
- <telerik:RadToolBarButton Text="Left" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Reset">
- <Buttons>
- <telerik:RadToolBarButton Text="Left" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
-
- Gets or sets a value indicating the client-side event handler that is called after a
- RadToolBarButton is checked.
-
-
- A string specifying the name of the JavaScript function that will handle the
- event. The default value is empty string.
-
-
- Use the OnClientCheckedStateChanged property to specify a
- JavaScript function that will be executed after a toolbar dropdown button
- is checked - either by left-clicking a checkable button or pressing the ENTER
- key after tabbing to that button.
- Two parameters are passed to the handler
-
- sender (the client-side RadToolBar object)
-
- eventArgs with two properties
-
-
item - the instance of the button which is checked
-
domEvent - the reference to the browser DOM event (null if the event was initiated by
- calling a client-side method such as button.toggle())
-
-
-
-
-
-
- The following example demonstrates how to use the
- OnClientCheckedStateChanged property.
-
- <script language="javascript">
- function clientCheckedStateChanged(sender, eventArgs)
- {
- var toolBar = sender;
- var button = eventArgs.get_item();
-
- alert(String.format("You just changed the checked state of the '{0}' button in the '{1}' toolBar.",
- button.get_text(), toolBar.get_id()));
-
- }
- </script>
-
- <telerik:RadToolBar id="RadToolBar1" runat="server"
- OnClientCheckedStateChanged="clientCheckedStateChanged">
- <Items>
- <telerik:RadToolBarButton Text="Left" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarDropDown Text="Align">
- <Buttons>
- <telerik:RadToolBarButton Text="Left" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarDropDown>
- <telerik:RadToolBarSplitButton Text="Reset">
- <Buttons>
- <telerik:RadToolBarButton Text="Left" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Center" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- <telerik:RadToolBarButton Text="Right" CheckOnClick="true" Group="Align" ></telerik:RadToolBarButton>
- </Buttons>
- </telerik:RadToolBarSplitButton>
- </Items>
- </telerik:RadToolBar>
-
-
-
-
- Occurs when a toolbar item is created.
-
- The ItemCreated event is raised when an item in the RadToolBar
- control is created, both during round-trips and at the time data is bound to the control.
- The ItemCreated event is not raised for items which are defined inline in the page or user control.
- The ItemCreated event is commonly used to initialize item properties.
-
-
- The following example demonstrates how to use the ItemCreated event
- to set the ToolTip property of each item.
-
- protected void RadToolBar1_ItemCreated(object sender, Telerik.Web.UI.RadToolBarEventArgs e)
- {
- e.Item.ToolTip = e.Item.Text;
- }
-
-
- Sub RadToolBar1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadToolBarEventArgs) Handles RadToolBar1.ItemCreated
- e.Item.ToolTip = e.Item.Text
- End Sub
-
-
-
-
- Occurs when a button is data bound.
-
-
- The ButtonDataBound event is raised for each button upon
- databinding. You can retrieve the button being bound using the event arguments.
- The DataItem associated with the button can be retrieved using
- the DataItem property.
-
- The ButtonDataBound event is often used in scenarios when you
- want to perform additional mapping of fields from the DataItem to their respective
- properties in the RadToolBarButton class.
-
-
- The following example demonstrates how to map fields from the data item to
- button properties using the ButtonDataBound
- event.
-
- protected void RadToolBar1_ButtonDataBound(object sender, Telerik.Web.UI.RadToolBarButtonEventArgs e)
- {
- e.Button.ImageUrl = "~/ToolBarImages/tool" + (string)DataBinder.Eval(e.Button.DataItem, "Text") + ".gif";
- e.Button.NavigateUrl = (string)DataBinder.Eval(e.Button.DataItem, "URL");
- }
-
-
- Sub RadToolBar1_ButtonDataBound(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadToolBarButtonEventArgs) Handles RadToolBar1.ButtonDataBound
- e.Button.ImageUrl = "~/ToolBarImages/tool" & CStr(DataBinder.Eval(e.Button.DataItem, "Text")) & ".gif"
- e.Button.NavigateUrl = CStr(DataBinder.Eval(e.Button.DataItem, "URL"))
- End Sub
-
-
-
-
-
- Occurs on the server when a button or in the RadToolBar
- control is clicked.
-
-
- The following example demonstrates how to use the ButtonClick event to
- determine the clicked button.
-
- protected void RadToolBar1_ButtonClick(object sender, Telerik.Web.UI.RadToolBarButtonEventArgs e)
- {
- Label1.Text = "Clicked button is " + e.Item.Text;
- }
-
-
- Sub RadToolBar1_ButtonClick(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadToolBarButtonEventArgs) Handles RadToolBar1.ButtonClick
- Label1.Text = "Clicked button is " & e.Item.Text;
- End Sub
-
-
-
-
-
- Text is the text in the input area of the combobox.
- This value can be used to filter the items that are added.
-
-
-
-
- Value is the value of the currently selected item.
-
-
-
-
- NumberOfItems is the number of items that have been added by all previous calls to the
- ItemsRequested event handler when the ShowMoreResultsBox property is True.
-
-
-
-
- EndOfItems is boolean property indicating that no more items should be requested.
- Once set, the serverside ItemsRequested event is no longer fired.
-
-
-
-
- Message is the message that appears in the ShowMoreResults box.
- This is only used when the ShowMoreResultsBox property is True.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
-
-
-
-
- Defines the filtering properties for a single column of the AutoFilter range.
-
-
-
-
- Defines a single condition in a custom AutoFilter function.
-
-
-
-
- Defines an AND condition in a custom AutoFilter function.
-
-
-
-
- Defines an OR condition in a custom AutoFilter function.
-
-
-
-
- Defines an AutoFilter range on the current worksheet.
-
-
-
-
- Max value 3
-
-
-
-
- This is required
-
-
-
-
- This element cannot have inner elements.
- Use Cells property
-
-
-
-
- This element cannot have attributes
-
-
-
- Represents the effects that can be used in an animation.
-
-
-
- Represents a ContextMenuTargettarget, specified
- by the id of a server control.
-
-
-
-
- An abstract class representing a target
- which RadContextMenu will be attached to.
-
-
-
-
- Gets or sets the ID of the server control RadContextMenu
- will attach to.
-
-
-
-
- Specifies that the RadContextMenu will be displayed
- when a right-click on the entire page occurs.
-
-
-
-
- Represents a ContextMenuTargettarget, specified
- by client-side element id.
-
-
-
-
- Gets or sets the ID of the element RadContextMenu
- will attach to on the client.
-
-
-
-
- Represents a ContextMenuTargettarget, specified
- by element tagName.
-
-
-
-
- Gets or sets the TagName of the elements RadContextMenu
- will search and attach to on the client.
-
-
-
-
- Represents a collection of objects.
-
-
-
-
- Initializes a new instance of the ContextMenuTargetCollection class.
-
- The owner of the collection.
-
-
-
- Appends the specified ContextMenuTarget object to the end of the current ContextMenuTargetCollection.
-
-
- The ContextMenuTarget to append to the end of the current ContextMenuTargetCollection.
-
-
-
-
- Determines whether the specified ContextMenuTarget object is in the current
- ContextMenuTargetCollection.
-
-
- The ContextMenuTarget object to find.
-
-
- true if the current collection contains the specified ContextMenuTarget object;
- otherwise, false.
-
-
-
-
- Copies the contents of the current ContextMenuTargetCollection into the
- specified array of ContextMenuTarget objects.
-
- The target array.
- The index to start copying from.
-
-
- Appends the specified array of ContextMenuTarget objects to the end of the
- current ContextMenuTargetCollection.
-
-
- The array of ContextMenuTarget o append to the end of the current
- ContextMenuTargetCollection.
-
-
-
-
- Determines the index of the specified ContextMenuTarget object in the collection.
-
-
- The ContextMenuTarget to locate.
-
-
- The zero-based index of tab within the current ContextMenuTargetCollection,
- if found; otherwise, -1.
-
-
-
-
- Inserts the specified ContextMenuTarget object in the current
- ContextMenuTargetCollection at the specified index location.
-
- The zero-based index location at which to insert the ContextMenuTarget.
- The ContextMenuTarget to insert.
-
-
-
- Removes the specified ContextMenuTarget object from the current
- ContextMenuTargetCollection.
-
-
- The ContextMenuTarget object to remove.
-
-
-
-
- Removes the ContextMenuTarget object at the specified index
- from the current ContextMenuTargetCollection.
-
- The zero-based index of the tab to remove.
-
-
-
- Gets the ContextMenuTarget object at the specified index in
- the current ContextMenuTargetCollection.
-
-
- The zero-based index of the ContextMenuTarget to retrieve.
-
-
- The ContextMenuTarget at the specified index in the
- current ContextMenuTargetCollection.
-
-
-
-
- This enumeration controls the expand behaviour of the items.
-
-
-
-
- The default behaviour - all items are loaded in the intial request and expand is performed on the client, without server interaction
-
-
-
-
- The child items are loaded from the web service specified by the RadMenu.WebServicePath and RadMenu.WebServiceMethod properties.
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a collection of objects.
-
-
-
-
- Gets the object at the specified index from the collection.
-
-
- The at the specified index in the collection.
-
-
- The zero-based index of the to retrieve.
-
-
-
-
- Defines the relationship between a data item and the menu item it is binding to in a
- control.
-
-
-
-
-
-
-
-
- Specifies the exact value of the ClickedCssClass property of the
- RadMenuItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ClickedCssClass property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledCssClass property of the
- RadMenuItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledCssClass property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledImageUrl property of the
- RadMenuItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledImageUrl property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ExpandedImageUrl property of the
- RadMenuItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ExpandedImageUrl property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ExpandedCssClass property of the
- RadMenuItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ExpandedCssClass property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ExpandMode property of the
- RadMenuItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ExpandMode property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the FocusedCssClass property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the FocusedCssClass property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the IsSeparator property of the
- RadMenuItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the IsSeparator property
- value of the RadMenuItem that will be created during
- the data binding.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Data class used for transferring menu items from and to web services.
-
-
- For information about the role of each property see the
- RadMenuItem class.
-
-
-
-
- See RadMenuItem.ExpandMode.
-
-
-
-
- See RadMenuItem.Selected.
-
-
-
-
- See RadMenuItem.NavigateUrl.
-
-
-
-
- See RadMenuItem.PostBack.
-
-
-
-
- See RadMenuItem.Target.
-
-
-
-
- See RadMenuItem.IsSeparator.
-
-
-
-
- See RadMenuItem.CssClass.
-
-
-
-
- See RadMenuItem.DisabledCssClass.
-
-
-
-
- See RadMenuItem.ExpandedCssClass.
-
-
-
-
- See RadMenuItem.FocusedCssClass.
-
-
-
-
- See RadMenuItem.ClickedCssClass.
-
-
-
-
- See RadMenuItem.ImageUrl.
-
-
-
-
- See RadMenuItem.HoveredImageUrl.
-
-
-
-
- See RadMenuItem.ClickedImageUrl.
-
-
-
-
- See RadMenuItem.DisabledImageUrl.
-
-
-
-
- See RadMenuItem.ExpandedImageUrl.
-
-
-
-
- Represents the different ways RadPanelbar behaves when an item is
- expanded.
-
-
-
- More than one item can be expanded at a time.
-
-
-
- Only one item can be expanded at a time. Expanding another item collapses the
- previously expanded one.
-
-
-
-
- Only one item can be expanded at a time. The expanded area occupies the entire height of the RadPanelbar.
-
-
-
- The position of the image within a panel item.
-
-
- The image is rendered leftmost.
-
-
- The image is rendered rightmost.
-
-
-
- Initializes a new instance of the
- RadMenuEventArgs class.
-
-
- A RadMenuItem which represents an item in the
- RadMenu control.
-
-
-
-
- Gets the referenced RadMenuItem in the
- RadMenu control when the event is raised.
-
-
- The referenced item in the RadMenu control when
- the event is raised.
-
-
- Use this property to programmatically access the item referenced in the
- RadMenu when the event is raised.
-
-
-
-
- For internal use only.
-
-
-
-
-
- Represents a item in the RadPanelBar control.
-
-
- The RadPanelBar control is made up of items. Items which are immediate children
- of the panelbar are root items. Items which are children of root items are child items.
-
-
- A item usually stores data in two properties, the Text property and
- the Value property. The value of the Text property is displayed
- in the RadPanelBar control, and the Value property is used to store additional data.
-
- To create panel items, use one of the following methods:
-
-
- Use declarative syntax to define items inline in your page or user control.
-
-
- Use one of the constructors to dynamically create new instances of the
- RadPanelItem class. These items can then be added to the
- Items collection of another item or panelbar.
-
-
- Data bind the RadPanelBar control to a data source.
-
-
-
- When the user clicks a panel item, the RadPanelBar control can navigate
- to a linked Web page, post back to the server or select that item. If the
- NavigateUrl property of a item is set, the
- RadPanelBar control navigates to the linked page. By default, a linked page
- is displayed in the same window or frame. To display the linked content in a different
- window or frame, use the Target property.
-
-
-
-
- Initializes a new instance of the RadPanelItem class.
-
- Use this constructor to create and initialize a new instance of the
- RadPanelItem class using default values.
-
-
- The following example demonstrates how to add items to
- RadPanelBar controls.
-
- RadPanelItem item = new RadPanelItem();
- item.Text = "News";
- item.NavigateUrl = "~/News.aspx";
-
- RadPanelbar1.Items.Add(item);
-
-
- Dim item As New RadPanelItem()
- item.Text = "News"
- item.NavigateUrl = "~/News.aspx"
-
- RadPanelbar1.Items.Add(item)
-
-
-
-
-
- Initializes a new instance of the RadPanelItem class with the
- specified text data.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadPanelItem class using the specified text.
-
-
-
- The following example demonstrates how to add items to
- RadPanelBar controls.
-
- RadPanelItem item = new RadPanelItem("News");
-
- RadPanelbar1.Items.Add(item);
-
-
- Dim item As New RadPanelItem("News")
-
- RadPanelbar1.Items.Add(item)
-
-
-
- The text of the item. The Text property is set to the value
- of this parameter.
-
-
-
-
- Expands all parent items so the item is visible.
-
-
-
-
- Initializes a new instance of the RadPanelItem class with the
- specified text and URL to navigate to.
-
-
-
- Use this constructor to create and initialize a new instance of the
- RadPanelItem class using the specified text and URL.
-
-
-
- This example demonstrates how to add items to RadPanelBar
- controls.
-
- RadPanelItem item = new RadPanelItem("News", "~/News.aspx");
-
- RadPanelbar1.Items.Add(item);
-
-
- Dim item As New RadPanelItem("News", "~/News.aspx")
-
- RadPanelbar1.Items.Add(item)
-
-
-
- The text of the item. The Text property is set to the value
- of this parameter.
-
-
- The url which the item will navigate to. The
- NavigateUrl property is set to the value of this
- parameter.
-
-
-
- Gets or sets a value indicating the position of the image within the item.
-
- One of the RadPanelItemImagePosition
- Enumeration values. The default value is Left.
-
-
-
- Gets the RadPanelBar instance which contains the item.
-
- Use this property to obtain an instance to the
- RadPanelBar object containing the item.
-
-
-
-
- Gets the IRadPanelItemContainer instance which contains the current item.
-
-
- The object which contains the item. It might be an instance of the
- RadPanelBar class or the RadPanelItem
- class depending on the hierarchy level.
-
-
- The value is of the IRadPanelItemContainer type which is
- implemented by the RadPanelBar class and the
- RadPanelItem class. Use the Owner property when
- recursively traversing items in the RadPanelBar control.
-
-
-
-
- Sets or gets whether the item is separator. It also represents a logical state of
- the item. Might be used in some applications for keyboard navigation to omit processing
- items that are marked as separators.
-
-
-
- Gets or sets a value indicating whether the panel item is expanded.
-
- true if the panel item is expanded; otherwise,
- false. The default is false.
-
-
-
-
- Manages the item level of a particular Item instance. This property allows easy
- implementation/separation of the panel items in levels.
-
-
-
- Gets or sets the height of the child item group.
-
- A Unit that represents the height of the child item group. The
- default value is Empty.
-
-
- If the total child group height exceeds the value specified with the
- ChildGroupHeight property scrolling will be applied.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied to the element enclosing the child items.
-
-
- The default value is empry string.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is
- disabled.
-
-
- The CSS class applied when the panel item is disabled. The default value is
- "disabled".
-
-
- By default the visual appearance of disabled panel items is defined in the skin CSS
- file. You can use the DisabledCssClass property to specify unique
- appearance for the panel item when it is disabled.
-
-
-
-
- Gets or sets a value indicating whether clicking on the item will
- postback.
-
-
- True if the panel item should postback; otherwise
- false. By default all the items will postback provided the user
- has subscribed to the ItemClick event.
-
-
- If you subscribe to the ItemClick all panel
- items will postback. To turn off that behavior you should set the
- PostBack property to false.
-
-
-
-
- Gets or sets a value indicating whether clicking on the item will
- collapse it.
-
-
- False if the panel item should collapse; otherwise
- True.
-
-
-
- Gets or sets a value indicating whether the item is selected.
-
- true if the item is selected; otherwise, false. The default is
- false.
-
-
- true if the item is selected; otherwise false.
- The default value is false.
-
-
- Use the Selected property to determine whether the item is currently selected.
-
-
-
- Gets or sets the text caption for the panel item.
- The text of the item. The default value is empty string.
-
- This example demonstrates how to set the text of the item using the
- Text property.
-
- <radP:RadPanelbar ID="RadPanelbar1"
- runat="server">
- <Items>
- <radP:RadPanelItem Text="News" />
- <radP:RadPanelItem Text="News" />
- </Items>
- </radP:RadPanelbar>
-
-
-
- Use the Text property to specify the text to display for the
- item.
-
-
-
- Gets or sets the URL to link to when the item is clicked.
-
- The URL to link to when the item is clicked. The default value is empty
- string.
-
-
- The following example demonstrates how to use the NavigateUrl
- property
-
- <telerik:RadPanelBar id="RadPanelBar1"
- runat="server">
- <Items>
- <telerik:RadPanelItem Text="News" NavigateUrl="~/News.aspx"
- />
- <telerik:RadPanelItem Text="External URL"
- NavigateUrl="http://www.example.com" />
- </Items>
- </telerik:RadPanelBar>
-
-
-
- Use the NavigateUrl property to specify the URL to link to when
- the item is clicked. Use "~" (tilde) in front of an URL within the same ASP.NET
- application. When specifying external URL do not forget the protocol (e.g.
- "http://").
-
-
-
-
- Gets or sets the target window or frame to display the Web page content linked to
- when the panel item is clicked.
-
-
- The target window or frame to load the Web page linked to when the Item is
- selected. Values must begin with a letter in the range of a through z (case
- insensitive), except for the following special values, which begin with an
- underscore:
-
-
-
- _blank
- Renders the content in a new window without
- frames.
-
-
- _parent
- Renders the content in the immediate frameset
- parent.
-
-
- _self
- Renders the content in the frame with focus.
-
-
- _top
- Renders the content in the full window without
- frames.
-
-
- The default value is empty string.
-
-
-
- Use the Target property to specify the frame or window that displays the
- Web page linked to when the panel item is clicked. The Web page is specified by
- setting the NavigateUrl property.
-
- If this property is not set, the Web page specified by the
- NavigateUrl property is loaded in the current window.
-
-
- The following example demonstrates how to use the Target
- property
- ASPX:
- <telerik:RadPanelBar runat="server" ID="RadPanelBar1">
- <Items>
- <telerik:RadPanelItem Target="_blank"
- NavigateUrl="http://www.google.com" />
- </Items>
- </telerik:RadPanelBar>
-
-
-
- Gets or sets the value associated with the panel item.
- The value associated with the item. The default value is empty string.
-
- Use the Value property to specify or determine the value associated
- with the item.
-
-
-
- Gets or sets the data item represented by the item.
-
- An object representing the data item to which the Item is bound to. The
- DataItem property will always return null when
- accessed outside of ItemDataBound
- event handler.
-
-
- This property is applicable only during data binding. Use it along with the
- ItemDataBound event to perform
- additional mapping of fields from the data item to
- RadPanelItem properties.
-
-
- The following example demonstrates how to map fields from the data item to
- %RadPanelItem properties. It assumes the user has subscribed to
- the ItemDataBound:RadPanelbar.ItemDataBound
- event.:RadPanelItem%
-
- private void RadPanelbar1_PanelItemDataBound(object sender, Telerik.WebControls.RadPanelbarEventArgs e)
- {
- RadPanelItem item = e.Item;
- DataRowView dataRow = (DataRowView) e.Item.DataItem;
-
- item.ImageUrl = "image" + dataRow["ID"].ToString() + ".gif";
- item.NavigateUrl = dataRow["URL"].ToString();
- }
-
-
- Sub RadPanel1_PanelItemDataBound(ByVal sender As Object, ByVal e As RadPanelbarEventArgs) Handles RadPanelbar1.ItemDataBound
- Dim item As RadPanelItem = e.Item
- Dim dataRow As DataRowView = CType(e.Item.DataItem, DataRowView)
-
- item.ImageUrl = "image" + dataRow("ID").ToString() + ".gif"
- item.NavigateUrl = dataRow("URL").ToString()
- End Sub
-
-
-
-
- Gets or sets the template for displaying the item.
-
- A ITemplate implemented object that contains the template
- for displaying the item. The default value is a null reference (Nothing in
- Visual Basic), which indicates that this property is not set.
-
- To specify common display for all panel items use the
- ItemTemplate property of the
- RadPanelbar class.
-
-
-
- The following template demonstrates how to add a Calendar control in certain
- panel item.
- ASPX:
- <radP:RadPanelbar runat="server" ID="RadPanelbar1">
-
- </radP:RadPanelbar>
-
-
-
- Gets or sets the path to an image to display for the item.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the ImageUrl property to specify the image for the item. If
- the ImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
-
- Gets or sets a value specifying the URL of the image rendered when the node is hovered with the mouse.
-
-
- If the HoveredImageUrl property is not set the ImageUrl property will be
- used when the node is hovered.
-
-
-
- Gets or sets the path to an image to display for the item when it is disabled.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the DisabledImageUrl property to specify the image for the item when it is disabled. If
- the DisabledImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
- Gets or sets the path to an image to display for the item when it is selected.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the SelectedImageUrl property to specify the image for the item when it is disabled. If
- the SelectedImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
- Gets or sets the path to an image to display for the item when it is expanded.
-
- The path to the image to display for the item. The default value is empty
- string.
-
-
- Use the ExpandedImageUrl property to specify the image for the item when it is expanded. If
- the ExpandedImageUrl property is set to empty string no image will be
- rendered. Use "~" (tilde) when referring to images within the current ASP.NET
- application.
-
-
-
-
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is
- clicked.
-
-
- The CSS class applied when the panel item is clicked. The default value is
- "clicked".
-
-
- By default the visual appearance of clicked panel items is defined in the skin CSS
- file. You can use the ClickedCssClass property to specify unique
- appearance for the panel item when it is clicked.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is
- selected.
-
-
- The CSS class applied when the panel item is selected. The default value is
- "selected".
-
-
- By default the visual appearance of selected panel items is defined in the skin CSS
- file. You can use the SelectedCssClass property to specify unique
- appearance for the panel item when it is selected.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is
- opened (its child items are visible).
-
-
- The CSS class applied when the panel item is opened. The default value is
- "expanded".
-
-
- By default the visual appearance of opened panel items is defined in the skin CSS
- file. You can use the ExpandedCssClass property to specify unique
- appearance for the panel item when it is opened.
-
-
-
-
- Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is
- focused.
-
-
- The CSS class applied when the panel item is focused. The default value is
- "focused".
-
-
- By default the visual appearance of focused panel items is defined in the skin CSS
- file. You can use the FocusedCssClass property to specify unique
- appearance for the panel item when it is focused.
-
-
-
-
- Represents the simple binding between the property value of an object and the property value of a
- RadPanelItem.
-
-
-
-
-
-
-
-
- Specifies the exact value of the ChildGroupCssClass property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ChildGroupCssClass property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ChildGroupHeight property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ChildGroupHeight property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ClickedCssClass property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ClickedCssClass property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledCssClass property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledCssClass property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledImageUrl property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledImageUrl property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the Expanded property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the Expanded property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ExpandedImageUrl property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ExpandedImageUrl property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ExpandedCssClass property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ExpandedCssClass property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the FocusedCssClass property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the FocusedCssClass property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ImagePosition property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ImagePosition property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the IsSeparator property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the IsSeparator property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the PreventCollapse property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the PreventCollapse property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the SelectedCssClass property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the SelectedCssClass property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the SelectedImageUrl property of the
- RadPanelItem that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the SelectedImageUrl property
- value of the RadPanelItem that will be created during
- the data binding.
-
-
-
-
- A collection of RadPanelItem objects in a
- RadPanelBar control.
-
-
- The RadPanelItemCollection class represents a collection of
- RadPanelItem objects.
-
-
- Use the indexer to programmatically retrieve a
- single RadPanelItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of panel items in the collection.
-
-
- Use the Add method to add items in the collection.
-
-
- Use the Remove method to remove items from the
- collection.
-
-
-
-
-
-
-
- Initializes a new instance of the RadPanelItemCollection class.
-
- The owner of the collection.
-
-
-
- Appends the specified RadPanelItem object to the end of the current RadPanelItemCollection.
-
-
- The RadPanelItem to append to the end of the current RadPanelItemCollection.
-
-
- The following example demonstrates how to programmatically add items in a
- RadPanelBar control.
-
- RadPanelItem newsItem = new RadPanelItem("News");
- RadPanelBar1.Items.Add(newsItem);
-
-
- Dim newsItem As RadPanelItem = New RadPanelItem("News")
- RadPanelBar1.Items.Add(newsItem)
-
-
-
-
- Appends the specified array of RadPanelItem objects to the end of the
- current RadPanelItemCollection.
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple items in a single step.
-
- RadPanelItem[] items = new RadPanelItem[] { new RadPanelItem("First"), new RadPanelItem("Second"), new RadPanelItem("Third") };
- RadPanelBar1.Items.AddRange(items);
-
-
- Dim items() As RadPanelItem = {New RadPanelItem("First"), New RadPanelItem("Second"), New RadPanelItem("Third")}
- RadPanelBar1.Items.AddRange(items)
-
-
-
- The array of RadPanelItem o append to the end of the current
- RadPanelItemCollection.
-
-
-
-
- Removes the specified RadPanelItem object from the current
- RadPanelItemCollection.
-
-
- The RadPanelItem object to remove.
-
-
-
-
- Removes the RadPanelItem object at the specified index
- from the current RadPanelItemCollection.
-
- The zero-based index of the item to remove.
-
-
-
- Determines the index of the specified RadPanelItem object in the collection.
-
-
- The RadPanelItem to locate.
-
-
- The zero-based index of item within the current RadPanelItemCollection,
- if found; otherwise, -1.
-
-
-
-
- Determines whether the specified RadPanelItem object is in the current
- RadPanelItemCollection.
-
-
- The RadPanelItem object to find.
-
-
- true if the current collection contains the specified RadPanelItem object;
- otherwise, false.
-
-
-
-
- Inserts the specified RadPanelItem object in the current
- RadPanelItemCollection at the specified index location.
-
- The zero-based index location at which to insert the RadPanelItem.
- The RadPanelItem to insert.
-
-
-
- Searches all nodes for a RadPanelItem with a Text property
- equal to the specified text.
-
- The text to search for
- A RadPanelItem whose Text property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
-
-
-
- Searches all nodes for a RadPanelItem with a Value property
- equal to the specified value.
-
- The value to search for
- A RadPanelItem whose Value property equals to the specified argument. Null (Nothing) is returned when no matching node is found.
- This method is not recursive.
-
-
-
- Searches the nodes in the collection for a RadPanelItem which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadPanelItem that matches the specified arguments. Null (Nothing) is returned if no node is found.
- This method is not recursive.
-
-
-
- Returns the first RadPanelItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadPanel1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadPanelItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadPanel1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadPanelItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Searches the RadPanelbar control for the first
- RadPanelItem with a Text property equal to
- the specified value.
-
-
- A RadPanelItem whose Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the RadPanelbar control for the first
- RadPanelItem with a Value property equal
- to the specified value.
-
-
- A RadPanelItem whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Gets the RadPanelItem object at the specified index in
- the current RadPanelItemCollection.
-
-
- The zero-based index of the RadPanelItem to retrieve.
-
-
- The RadPanelItem at the specified index in the
- current RadPanelItemCollection.
-
-
-
-
- SpellCheckValidator validates a form based on a RadSpell control. It can be used to enforce spellchecking before form submission.
- The ControlToValidate must be set to the ID of a RadSpell control. The RadSpell control should be separately set up with a control to check and other options.
-
-
-
-
- A collection of RadToolBarButton objects in
- RadToolBarDropDown and
- RadToolBarSplitButton.
-
-
- The RadToolBarButtonCollection class represents a collection of
- RadToolBarButton objects. The RadToolBarButton objects
- in turn represent buttons within a RadToolBarDropDown or
- a RadToolBarSplitButton.
-
-
- Use the indexer to programmatically retrieve a
- single RadToolBarButton from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of buttons in the collection.
-
-
- Use the Add method to add buttons to the collection.
-
-
- Use the Remove method to remove buttons from the
- collection.
-
-
-
-
-
-
- A collection of RadToolBarItem objects in a
- RadToolBar control.
-
-
- The RadToolBarItemCollection class represents a collection of
- RadToolBarItem objects. The RadToolBarItem objects
- in turn represent items (buttons, dropdowns or split buttons) within a
- RadToolBar control.
-
- Use the indexer to programmatically retrieve a
- single RadToolBarItem from the collection, using array notation.
-
-
- Use the Count property to determine the total
- number of toolbar items in the collection.
-
-
- Use the Add method to add toolbar items to the collection.
-
-
- Use the Remove method to remove toolbar items from the
- collection.
-
-
-
-
-
-
- Initializes a new instance of the RadToolBarItemCollection class.
-
- The owner of the collection.
-
-
-
- Appends the specified RadToolBarItem object to the end of the
- current RadToolBarItemCollection.
-
-
- The RadToolBarItem to append to the end of the current
- RadToolBarItemCollection.
-
-
- The following example demonstrates how to programmatically add toolbar buttons in a
- RadToolBar control.
-
- RadToolBarButton createNewButton = new RadToolBarButton("CreateNew");
- RadToolBar1.Items.Add(createNewButton);
-
-
- Dim createNewButton As RadToolBarButton = New RadToolBarButton("CreateNew")
- RadToolBar1.Items.Add(createNewButton)
-
-
-
-
-
- Searches the ToolBarItemCollection for the first
- RadToolBarItem with a Text property equal to
- the specified value.
-
-
- A RadToolBarItem which Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the ToolBarItemCollection for the first button item
- (RadToolBarButton or
- RadToolBarSplitButton) with a
- Value property equal
- to the specified value.
-
-
- A button item which Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the ToolBarItemCollection for the first
- RadToolBarItem with a Text property equal to
- the specified value.
-
-
- A RadToolBarItem which Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the ToolBarItemCollection for the first button item
- (RadToolBarButton or
- RadToolBarSplitButton) with a
- Value property equal
- to the specified value.
-
-
- A button item which Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
- A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
-
-
-
- Searches the items in the collection for a RadToolBarItem which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadToolBarItem that matches the specified arguments. Null (Nothing) is returned if no node is found.
- This method is not recursive.
-
-
-
- Returns the first RadToolBarItem
- that matches the conditions defined by the specified predicate.
- The predicate should returns a boolean value.
-
-
- The following example demonstrates how to use the FindItem method.
-
- void Page_Load(object sender, EventArgs e)
- {
- RadToolBar1.FindItem(ItemWithEqualsTextAndValue);
- }
- private static bool ItemWithEqualsTextAndValue(RadToolBarItem item)
- {
- if (item.Text == item.Value)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
-
-
- Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
- RadToolBar1.FindItem(ItemWithEqualsTextAndValue)
- End Sub
- Private Shared Function ItemWithEqualsTextAndValue(ByVal item As RadToolBarItem) As Boolean
- If item.Text = item.Value Then
- Return True
- Else
- Return False
- End If
- End Function
-
-
- The Predicate <> that defines the conditions of the element to search for.
-
-
-
- Determines whether the specified RadToolBarItem object is in the current
- RadToolBarItemCollection.
-
-
- The RadToolBarItem object to find.
-
-
- true if the current collection contains the specified
- RadToolBarItem object; otherwise, false.
-
-
-
-
- Appends the specified array of RadToolBarItem objects
- to the end of the current RadToolBarItemCollection.
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple items in a single step.
-
- RadToolBarItem[] items = new RadToolBarItem[] { new RadToolBarButton("Create New"),
- new RadToolBarDropDown("Manage"),
- new RadToolBarSplitButton("Register Purchase")};
- RadToolBar1.Items.AddRange(items);
-
-
- Dim items() As RadToolBarItem = {New RadToolBarButton("Create New"),
- New RadToolBarDropDown("Manage"),
- New RadToolBarSplitButton("Register Purchase")}
- RadToolBar1.Items.AddRange(items)
-
-
-
- The array of RadToolBarItem objects to append to the end of the current
- RadToolBarItemCollection.
-
-
-
-
- Determines the index of the specified RadToolBarItem object in
- the collection.
-
-
- The RadToolBarItem to locate.
-
-
- The zero-based index of a toolbar item within the current
- RadToolBarItemCollection,
- if found; otherwise, -1.
-
-
-
-
- Inserts the specified RadToolBarItem object in the current
- RadToolBarItemCollection at the specified index location.
-
- The zero-based index location at which to insert the
- RadToolBarItem.
- The RadToolBarItem to insert.
-
-
-
- Removes the specified RadToolBarItem object from the current
- RadToolBarItemCollection.
-
-
- The RadToolBarItem object to remove.
-
-
-
-
- Removes the RadToolBarItem object at the specified index
- from the current RadToolBarItemCollection.
-
- The zero-based index of the item to remove.
-
-
-
- Gets the RadToolBarItem object at the specified index in
- the current RadToolBarItemCollection.
-
-
- The zero-based index of the RadToolBarItem to retrieve.
-
-
- The RadToolBarItem at the specified index in the
- current RadToolBarItemCollection.
-
-
-
-
- Initializes a new instance of the
- RadToolBarButtonCollection class.
-
- The owner of the collection.
-
-
-
- Appends the specified RadToolBarButton object to the end of the
- current RadToolBarButtonCollection.
-
-
- The RadToolBarButton to append to the end of the current
- RadToolBarButtonCollection.
-
-
- The following example demonstrates how to programmatically add toolbar buttons to a
- RadToolBarDropDown.
-
- RadToolBarDropDown manageDropDown = new RadToolBarDropDown("Manage");
-
- RadToolBarButton manageUsersButton = new RadToolBarButton("Users");
- manageDropDown.Buttons.Add(manageUsersButton);
-
- RadToolBarButton manageOrdersButton = new RadToolBarButton("Orders");
- manageDropDown.Buttons.Add(manageOrdersButton);
-
- RadToolBar1.Items.Add(manageDropDown);
-
-
- Dim manageDropDown As RadToolBarDropDown = New RadToolBarDropDown("Manage")
-
- Dim manageUsersButton As RadToolBarButton = New RadToolBarButton("Users")
- manageDropDown.Buttons.Add(manageUsersButton)
-
- Dim manageOrdersButton As RadToolBarButton = New RadToolBarButton("Orders")
- manageDropDown.Buttons.Add(manageOrdersButton)
-
- RadToolBar1.Items.Add(manageDropDown)
-
-
-
-
-
- Searches the RadToolBarButtonCollection for the first
- RadToolBarButton with a Text property equal to
- the specified value.
-
-
- A RadToolBarButton which Text property is equal
- to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the RadToolBarButtonCollection for the first
- RadToolBarButton with a Value property equal
- to the specified value.
-
-
- A RadToolBarButton whose Value property is
- equal to the specified value.
-
-
- The method returns the first item matching the search criteria. This method is not recursive. If no item is
- matching then null (Nothing in VB.NET) is
- returned.
-
- The value to search for.
-
-
-
- Searches the items in the collection for a RadToolBarButton
- which contains the specified attribute and attribute value.
-
- The name of the target attribute.
- The value of the target attribute
- The RadToolBarButton that matches the specified arguments.
- Null (Nothing) is returned if no node is found.
- This method is not recursive.
-
-
-
- Determines whether the specified RadToolBarButton object
- is in the current RadToolBarButtonCollection.
-
-
- The RadToolBarButton object to find.
-
-
- true if the current collection contains the specified
- RadToolBarButton object; otherwise, false.
-
-
-
-
- Appends the specified array of RadToolBarButton objects
- to the end of the current RadToolBarButtonCollection.
-
-
- The following example demonstrates how to use the AddRange method
- to add multiple buttons in a single step.
-
- RadToolBarDropDown manageDropDown = new RadToolBarDropDown("Manage");
- RadToolBarButton[] buttons = new RadToolBarButton[] { new RadToolBarButton("Users"),
- new RadToolBarButton("Orders")};
-
- manageDropDown.Buttons.AddRange(buttons);
-
- RadToolBar1.Items.Add(manageDropDown);
-
-
- Dim manageDropDown As RadToolBarDropDown = New RadToolBarDropDown("Manage")
- Dim buttons() As RadToolBarButton = {New RadToolBarButton("Users"),
- New RadToolBarButton("Orders")}
-
- manageDropDown.Buttons.AddRange(buttons)
-
- RadToolBar1.Items.Add(manageDropDown)
-
-
-
- The array of RadToolBarButton objects to append to
- the end of the current RadToolBarButtonCollection.
-
-
-
-
- Determines the index of the specified RadToolBarButton object in
- the collection.
-
-
- The RadToolBarButton to locate.
-
-
- The zero-based index of a toolbar button within the current
- RadToolBarButtonCollection,
- if found; otherwise, -1.
-
-
-
-
- Inserts the specified RadToolBarButton object in the current
- RadToolBarButtonCollection at the specified index location.
-
- The zero-based index location at which to insert the
- RadToolBarButton.
- The RadToolBarButton to insert.
-
-
-
- Removes the specified RadToolBarButton object from the current
- RadToolBarButtonCollection.
-
-
- The RadToolBarButton object to remove.
-
-
-
-
- Removes the RadToolBarButton object at the specified index
- from the current RadToolBarButtonCollection.
-
- The zero-based index of the button to remove.
-
-
-
- Gets the RadToolBarButton object at the specified index in
- the current RadToolBarButtonCollection.
-
-
- The zero-based index of the RadToolBarButton to retrieve.
-
-
- The RadToolBarButton at the specified index in the
- current RadToolBarButtonCollection.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents the animation settings like type and duration for the control.
-
-
-
- Gets or sets the duration in milliseconds of the animation.
-
- An integer representing the duration in milliseconds of the animation.
- The default value is 450 milliseconds.
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- A context menu control used with the control.
-
-
-
- The RadTreeViewContextMenu object is used to assign context menus to nodes. Use the
- property to add context menus for a
- object.
-
-
- Use the property to assign specific context menu to a given .
-
-
-
- The following example demonstrates how to add context menus declaratively
-
- <telerik:RadTreeView ID="RadTreeView1" runat="server">
- <ContextMenus>
- <telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <telerik:RadMenuItem Text="Menu1Item1"></telerik:RadMenuItem>
- <telerik:RadMenuItem Text="Menu1Item2"></telerik:RadMenuItem>
- </Items>
- </telerik:RadTreeViewContextMenu>
- <telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <telerik:RadMenuItem Text="Menu2Item1"></telerik:RadMenuItem>
- <telerik:RadMenuItem Text="Menu2Item2"></telerik:RadMenuItem>
- </Items>
- </telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- <telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeNode>
- <telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- <telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeNode>
- </Nodes>
- </telerik:RadTreeView>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- OnClientItemClicking is not available for RadTreeViewContextMenu. Use the OnClientContextMenuItemClicking property of RadTreeView instead.
-
-
-
-
- OnClientItemClicked is not available for RadTreeViewContextMenu. Use the OnClientContextMenuItemClicked property of RadTreeView instead.
-
-
-
-
- OnClientShowing is not available for RadTreeViewContextMenu. Use the OnClientContextMenuShowing property of RadTreeView instead.
-
-
-
-
- OnClientShown is not available for RadTreeViewContextMenu. Use the OnClientContextMenuShown property of RadTreeView instead.
-
-
-
-
- Provides a collection container that enables RadTreeView to maintain a list of its RadTreeViewContextMenus.
-
-
-
-
- Initializes a new instance of the RadTreeViewContextMenuCollection class for the specified RadTreeView.
-
- The RadTreeView that the RadTreeViewContextMenuCollection is created for.
-
-
-
- Adds the specified RadTreeViewContextMenu object to the collection
-
- The RadTreeViewContextMenu to add to the collection
-
-
-
- Determines whether the specified RadTreeViewContextMenu is in the parent
- RadTreeView's RadTreeViewContextMenuCollection object.
-
- The RadTreeViewContextMenu to search for in the collection
- true if the specified RadTreeViewContextMenu exists in
- the collection; otherwise, false.
-
-
-
- Copies the RadTreeViewContextMenu instances stored in the
- RadTreeViewContextMenuCollection
- object to an System.Array object, beginning at the specified index location in the System.Array.
-
- The System.Array to copy the RadTreeViewContextMenu instances to.
- The zero-based relative index in array where copying begins
-
-
- Appends the specified array of objects to the end of the
- current .
-
-
- The array of to append to the end of the current
- .
-
-
-
-
- Retrieves the index of a specified RadTreeViewContextMenu object in the collection.
-
- The RadTreeViewContextMenu
- for which the index is returned.
- The index of the specified RadTreeViewContextMenu
- instance. If the RadTreeViewContextMenu is not
- currently a member of the collection, it returns -1.
-
-
-
- Inserts the specified RadTreeViewContextMenu object
- to the collection at the specified index location.
-
- The location in the array at which to add the RadTreeViewContextMenu instance.
- The RadTreeViewContextMenu to add to the collection
-
-
-
- Removes the specified RadTreeViewContextMenu
- from the parent RadTreeView's RadTreeViewContextMenuCollection
- object.
-
- The RadTreeViewContextMenu to be removed
- To remove a control from an index location, use the RemoveAt method.
-
-
-
- Removes a child RadTreeViewContextMenu, at the
- specified index location, from the RadTreeViewContextMenuCollection
- object.
-
- The ordinal index of the RadTreeViewContextMenu
- to be removed from the collection.
-
-
-
- Gets a reference to the RadTreeViewContextMenu at the specified index location in the
- RadTreeViewContextMenuCollection object.
-
- The location of the RadTreeViewContextMenu in the RadTreeViewContextMenuCollection
- The reference to the RadTreeViewContextMenu.
-
-
-
- Represents the method that handles the ContextMenuItemClick
- event of a RadTreeView control.
-
- The source of the event.
- A RadTreeViewContextMenuEventArgs
- that contains the event data.
-
-
- The ContextMenuItemClick event is raised
- when an item in the RadTreeViewContextMenu of the
- RadTreeView control is clicked.
-
-
- A click on a RadTreeViewContextMenu item of the
- RadTreeView makes a postback only if an event handler is attached
- to the ContextMenuItemClick event.
-
-
-
- The following example demonstrates how to display information about the clicked item in the
- RadTreeViewContextMenu shown after a right-click
- on a RadTreeNode.
-
- <%@ Page Language="C#" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- void RadTreeView1_ContextMenuItemClick(object sender, RadTreeViewContextMenuEventArgs e)
- {
- lblInfo.Text = string.Format(@"You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")",
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text);
- }
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
- <%@ Page Language="VB" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- Sub RadTreeView1_ContextMenuItemClick(ByVal sender as Object, ByVal e as RadTreeViewContextMenuEventArgs)
- lblInfo.Text = String.Format("You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")", _
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text)
- End Sub
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
-
-
-
- Provides data for the ContextMenuItemClick
- event of the RadTreeView control. This class cannot be inherited.
-
-
-
- The ContextMenuItemClick event is raised
- when an item in the RadTreeViewContextMenu of the
- RadTreeView control is clicked.
-
-
- A click on a RadTreeViewContextMenu item of the
- RadTreeView makes a postback only if an event handler is attached
- to the ContextMenuItemClick event.
-
-
-
- The following example demonstrates how to display information about the clicked item in the
- RadTreeViewContextMenu shown after a right-click
- on a RadTreeNode.
-
- <%@ Page Language="C#" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- void RadTreeView1_ContextMenuItemClick(object sender, RadTreeViewContextMenuEventArgs e)
- {
- lblInfo.Text = string.Format(@"You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")",
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text);
- }
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
- <%@ Page Language="VB" AutoEventWireup="true" %>
- <%@ Register TagPrefix="Telerik" Namespace="Telerik.Web.UI" Assembly="Telerik.Web.UI" %>
-
- <script runat="server">
- Sub RadTreeView1_ContextMenuItemClick(ByVal sender as Object, ByVal e as RadTreeViewContextMenuEventArgs)
- lblInfo.Text = String.Format("You clicked on Menu Item {0}(""{1}"") of Node {2}(""{3}"")", _
- e.MenuItem.Index, e.MenuItem.Text, e.Node.Index, e.Node.Text)
- End Sub
- </script>
-
- <html>
- <body>
- <form id="form1" runat="server">
- <Telerik:RadScriptManager ID="RadScriptManager1" runat="server"></Telerik:RadScriptManager>
- <br />
- <asp:Label ID="lblInfo" style="border:solid 1px black; background-color:InfoBackground;font:normal 12px Courier New;" runat="server">Click on a context menu item to see the information for it.</asp:Label>
- <br />
- <Telerik:RadTreeView ID="RadTreeView1" runat="server" OnContextMenuItemClick="RadTreeView1_ContextMenuItemClick">
- <ContextMenus>
- <Telerik:RadTreeViewContextMenu ID="ContextMenu1">
- <Items>
- <Telerik:RadMenuItem Text="Menu1Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu1Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- <Telerik:RadTreeViewContextMenu Skin="Outlook" ID="ContextMenu2">
- <Items>
- <Telerik:RadMenuItem Text="Menu2Item1"></Telerik:RadMenuItem>
- <Telerik:RadMenuItem Text="Menu2Item2"></Telerik:RadMenuItem>
- </Items>
- </Telerik:RadTreeViewContextMenu>
- </ContextMenus>
- <Nodes>
- <Telerik:RadTreeNode Text="Node1" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node11" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node12" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node2" ContextMenuID="ContextMenu2">
- <Nodes>
- <Telerik:RadTreeNode Text="Node21" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- <Telerik:RadTreeNode Text="Node22" ContextMenuID="ContextMenu2"></Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeNode>
- </Nodes>
- </Telerik:RadTreeView>
-
- </form>
- </body>
- </html>
-
-
-
-
-
- Initializes a new instance of the RadTreeViewContextMenuEventArgs class.
-
- A RadTreeNode which represents a
- node in the RadTreeView control.
-
- A RadMenuItem which represents an
- item in the RadTreeViewContextMenu control.
-
-
-
-
- Gets the referenced RadMenuItem in the
- RadTreeViewContextMenu control
- when the event is raised.
-
-
- Use this property to programmatically access the item referenced in the
- RadTreeViewContextMenu when the event is raised.
-
-
-
-
- Gets the referenced RadTreeNode in the
- RadTreeView control when the event is raised.
-
-
- Use this property to programmatically access the item referenced in the
- RadTreeNode when the event is raised.
-
-
-
-
- Specifies the checked state of .
-
-
-
-
- The is not checked
-
-
-
-
- The is checked
-
-
-
-
- The is in Indeterminate mode (some of its child nodes is not checked)
-
-
-
-
- This enumeration controls the expand behaviour of the nodes.
-
-
-
-
- The default behaviour - all nodes are loaded in the intial request and expand is performed on the client, without server interaction
-
-
-
-
- Forces firing of the NodeExpand event - a postback occurs and developers can populate the node with its children in server side event handler
-
-
-
-
- Forces firing of the NodeExpand event asyncronously from the client without postback - the NodeExpand event fires and child nodes added to the node collection are automatically transferred to the client without postback.
-
-
-
-
- The child nodes are loaded from the web service specified by the RadTreeView.WebServicePath and RadTreeView.WebServiceMethod properties.
-
-
-
-
- Specifies where the loading message is shown when Client-side load on demand is used.
-
-
-
-
- If the node text is "Some Text", the text is changed to "(loading ...) Some Text" when child nodes are being loaded (Assuming the LoadingMessage property has been set to "(loading...)";
-
-
-
-
- If the node text is "Some Text", the text is changed to "Some Text (loading ...)" when child nodes are being loaded (Assuming the LoadingMessage property has been set to "(loading...)";
-
-
-
-
- The text is not changed and (loading ...)" when child nodes are being loaded (Assuming the LoadingMessage property has been set to "(loading...)";
-
-
-
-
- No loading text is displayed at all.
-
-
-
-
- Specifies the position at which the user has dragged and dropped the source node(s) with regards to the
- destination node.
-
-
-
-
- The source node(s) is dropped over (onto) the destination node.
-
-
-
-
- The source node(s) is dropped above (before) the destination node.
-
-
-
-
- The source node(s) is dropped below (after) the destination node.
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Initializes a new instance of the class.
-
- A list of objects representing the source (dragged) nodes.
- A representing the destination node.
-
- A value representing the drop position of the
- source node(s) with regards to the destination node.
-
-
-
-
- Initializes a new instance of the class.
-
- A list of objects representing the source (dragged) nodes.
- A string representing the id of the HTML element on which the source nodes are dropped.
-
-
-
- Gets the source (dragged) node.
-
-
- A object representing the currently dragged node. The first dragged node is
- returned if there is more than one dragged node.
-
-
-
-
- Gets the destination node.
-
-
- A object representing the destination node.
-
-
-
-
- Gets all source (dragged) nodes.
-
-
- A list of object representing the source nodes.
-
-
-
-
- Gets or sets the position at which the user drops the source node(s) with regards to the destination nodes.
-
-
- One of the enumeration values.
-
-
-
-
- Gets or sets the ID of the HTML element on which the source node(s) is dropped.
-
-
- A string representing the ID of the HTML element on which the source node(s) is dropped.
-
-
-
-
- Provides data for the event of the control.
-
-
-
-
- Provides data for the , ,
- , ,
- and
- events of the control.
-
-
-
-
- Initializes a new instance of the class.
-
-
- A which represents a node in the control.
-
-
-
-
- Gets the referenced node in the control when the event is raised.
-
-
- The referenced node in the control when the event is raised.
-
-
- Use this property to programmatically access the node referenced in the control when the event is raised.
-
-
-
-
- Initializes a new instance of the class
-
- A object representing the node being edited.
- A string representing the text entered by the user.
-
-
-
- Gets the text which the user entered during node editing.
-
-
-
-
- Represents the method that handles the event provided by the control.
-
-
-
-
- Represents the method that handles the event provided by the control.
-
-
-
-
- Represents the method that handles the , ,
- , ,
- and
- events provided by the control.
-
-
-
-
- Data class used for transferring tree nodes from and to web services.
-
-
- For information about the role of each property see the
- class.
-
-
-
-
- See RadTreeNode.ExpandMode.
-
-
-
-
- See RadTreeNode.NavigateUrl.
-
-
-
-
- See RadTreeNode.PostBack.
-
-
-
-
- The CssClass of the RadTreeNode.
-
-
-
-
- See RadTreeNode.DisabledCssClass.
-
-
-
-
- See RadTreeNode.SelectedCssClass.
-
-
-
-
- See RadTreeNode.ContentCssClass.
-
-
-
-
- See RadTreeNode.HoveredCssClass.
-
-
-
-
- See RadTreeNode.ImageUrl.
-
-
-
-
- See RadTreeNode.HoveredImageUrl.
-
-
-
-
- See RadTreeNode.DisabledImageUrl.
-
-
-
-
- See RadTreeNode.ExpandedImageUrl.
-
-
-
-
- See RadTreeNode.ContextMenuID.
-
-
-
-
- Represents the simple binding between the property value of an object and the property value of a
- RadTreeNode.
-
-
-
-
- Specifies the exact value of the ContextMenuID property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ContextMenuID property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the AllowDrag property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the AllowDrag property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the AllowDrop property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the AllowDrop property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the AllowEdit property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the AllowEdit property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the Category property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the Category property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the Checkable property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the Checkable property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the Checked property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the Checked property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledCssClass property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledCssClass property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the DisabledImageUrl property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the DisabledImageUrl property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the EnableContextMenu property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the EnableContextMenu property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the Expanded property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the Expanded property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ExpandedImageUrl property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ExpandedImageUrl property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ExpandMode property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ExpandMode property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the HoveredCssClass property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the HoveredCssClass property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the SelectedCssClass property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the SelectedCssClass property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the ContentCssClass property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the ContentCssClass property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Specifies the exact value of the SelectedImageUrl property of the
- RadTreeNode that will be created during the data binding.
-
-
-
-
- Specifies the field, containing the SelectedImageUrl property
- value of the RadTreeNode that will be created during
- the data binding.
-
-
-
-
- Defines the relationship between a data item and the menu item it is binding to in a
- control.
-
-
-
-
- Gets the object at the specified index in
- the current .
-
-
- The zero-based index of the to retrieve.
-
-
- The at the specified index in the
- current .
-
-
-
-
- Represents the animation settings like type and duration for the control.
-
-
-
- Gets or sets the duration in milliseconds of the animation.
-
- An integer representing the duration in milliseconds of the animation.
- The default value is 200 milliseconds
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- Represents the method that will handle the event that has an
- UploadedFileEventArgs event data.
-
- The RadUpload instance which fired the event.
- An UploadedFileEventArgs that contain the event data.
-
-
-
- UploadedFileEventArgs is the base class for the RadUpload event data.
-
-
-
- Gets the currently processed UploadedFile.
-
- UploadedFile object that contains information about
- the currently processed file.
-
-
- The following example demonstrates how to use the
- UploadedFile property to save a file in the
- FileExists event.
-
- Private Sub RadUpload1_FileExists(ByVal sender As Object, ByVal e As WebControls.UploadedFileEventArgs) Handles RadUpload1.FileExists
- Dim TheFile As Telerik.WebControls.UploadedFile = e.UploadedFile
-
- e.UploadedFile.SaveAs(Path.Combine(RadUpload1.TargetFolder, TheFile.GetName + "1" + TheFile.GetExtension))
- End Sub
-
-
- private void RadUpload1_FileExists(object sender, Telerik.WebControls.UploadedFileEventArgs e)
- {
- Telerik.WebControls.UploadedFile TheFile = e.UploadedFile;
-
- TheFile.SaveAs(Path.Combine(RadUpload1.TargetFolder, TheFile.GetName() + "1" + TheFile.GetExtension()));
- }
-
-
-
-
-
- Represents the method that will handle the custom validation event.
-
- The RadUpload instance which fired the event.
-
- A ValidateFileEventArgs that contain the
- event data.
-
-
-
-
- Provides data for the ValidatingFile
- event of the RadUpload control.
-
-
-
- A ValidatingFileEventArgs is passed to the
- ValidatingFile event handler to
- provide event data to the handler. The
- ValidatingFile event event is raised
- when validation is performed on the server. This allows you to perform a custom
- server-side validation routine on a file of a
- RadUpload control.
-
-
-
-
-
- Gets or sets whether the value specified by
- UploadedFile property passed
- validation.
-
-
- true to indicate that the value specified by the
- UploadedFile property passed
- validation; otherwise, false
-
-
-
- Once your validation routine finishes, use the IsValid
- property to indicate whether the value specified by the
- UploadedFile property
- passed validation. This value determines whether the file from the
- RadUpload control passed validation.
-
-
-
- This example demonstrates how to implement validation for filenames.
-
- Private Sub RadUpload1_ValidatingFile(ByVal sender As Object, ByVal e As WebControls.ValidateFileEventArgs) Handles RadUpload1.ValidatingFile
- If e.UploadedFile.GetExtension.ToLower() = ".zip" Then
- 'The zip files are not allowed for upload
- e.IsValid = False
- End If
- End Sub
-
-
- private void RadUpload1_ValidatingFile(object sender, ValidateFileEventArgs e)
- {
- if (e.UploadedFile.GetExtension().ToLower() == ".zip")
- {
- //The zip files are not allowed for upload
- e.IsValid = false;
- }
- }
-
-
-
-
-
- Gets or sets whether the internal validation should continue validating the file
- specified by the UploadedFile property.
-
-
- false to indicate that the internal validation should validate
- the file specified by the UploadedFile property; otherwise,
- true
-
-
- Once your validation routine finishes, use the SkipInternalValidation
- property to skip the internal validation provided by the RadUpload
- control.
-
-
- This example demostrates how to implement custom validation for specific file type.
-
-
- Private Sub RadUpload1_ValidatingFile(ByVal sender As Object, ByVal e As WebControls.ValidateFileEventArgs) Handles RadUpload1.ValidatingFile
- If e.UploadedFile.GetExtension.ToLower = ".zip" Then
- Dim maxZipFileSize As Integer = 10000000 '~10MB
- If e.UploadedFile.ContentLength > maxZipFileSize Then
- e.IsValid = False
- End If
- 'The zip files are not validated for file size, extension and mime type
- e.SkipInternalValidation = True
- End If
- End Sub
-
-
- private void RadUpload1_ValidatingFile(object sender, ValidateFileEventArgs e)
- {
- if (e.UploadedFile.GetExtension().ToLower() == ".zip")
- {
- int maxZipFileSize = 10000000; //~10MB
- if (e.UploadedFile.ContentLength > maxZipFileSize)
- {
- e.IsValid = false;
- }
- //The zip files are not validated for file size, extension and content type
- e.SkipInternalValidation = true;
- }
- }
-
-
- MaxFileSize Property (Telerik.WebControls.RadUpload)
- AllowedMimeTypes Property (Telerik.WebControls.RadUpload)
- AllowedFileExtensions Property (Telerik.WebControls.RadUpload)
-
-
-
- Derives from HttpWorker request; Updates the current RadProgressContext
- with upload progress information;
-
-
-
-
- Stores a single request field - header data and body info (does not hold the entire body).
- No boundary here.
-
-
-
-
- Continuously fills the current request field member (header or body);
-
- The byte data of the current request field
- Indicates if this is the last chunk of information
-
-
-
- Returns null if the header is not complete yet:
-
-
-
-
- Records field information
-
- the raw byte array for the field (if the entire field is in the byte array,
- this would include the header and the body)
- indicates if this is the final part of the field body data (e.g., in terms
- of the request parser - if the boundary is reached after this field)
-
-
-
- Contains only fields with complete headers
-
-
-
-
- The most current field, which header is complete
-
-
-
-
- For internal use only.
-
-
-
-
-
-
- RadXmlHttpPanel class
-
-
-
-
diff --git a/Source/ReleaseNotes_03.05.00.htm b/Source/ReleaseNotes_03.05.00.htm
new file mode 100644
index 0000000..3d811ca
--- /dev/null
+++ b/Source/ReleaseNotes_03.05.00.htm
@@ -0,0 +1,32 @@
+
+
Change Log
+
+
Version 3.5.0
+
+
Requires DNN Platform version 6.0.0 or higher
+
Fix error with re-ordering questions and answers
+
+
Version 3.4.4
+
+
Fix error when analyzing reponses in some DNN 7 sites
+
+
Version 3.4.3
+
+
Disable Submit button after submitting a survey
+
Add "submitting" CSS class to the form after submitting a survey
+
+
Version 3.4.2
+
+
Fixed error when survey is completed by an anonymous user
+
+
Version 3.4.1
+
+
Fixed error when survey has only free-text questions
\ No newline at end of file
diff --git a/Source/Settings.ascx.cs b/Source/Settings.ascx.cs
index f9df29c..7895f8b 100644
--- a/Source/Settings.ascx.cs
+++ b/Source/Settings.ascx.cs
@@ -1,6 +1,6 @@
//
// Engage: Survey
-// Copyright (c) 2004-2013
+// Copyright (c) 2004-2014
// by Engage Software ( http://www.engagesoftware.com )
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
@@ -192,7 +192,7 @@ private void SetMinimumTimeoutEnable()
}
///
- /// Handles the event of the control.
+ /// Handles the event of the control.
///
/// The source of the event.
/// The instance containing the event data.
diff --git a/Source/SurveyListing.ascx.cs b/Source/SurveyListing.ascx.cs
index 3fab776..edf120e 100644
--- a/Source/SurveyListing.ascx.cs
+++ b/Source/SurveyListing.ascx.cs
@@ -1,6 +1,6 @@
//
// Engage: Survey
-// Copyright (c) 2004-2013
+// Copyright (c) 2004-2014
// by Engage Software ( http://www.engagesoftware.com )
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
diff --git a/Source/SurveyQueryStringBuilder.cs b/Source/SurveyQueryStringBuilder.cs
index 3188830..a63e7aa 100644
--- a/Source/SurveyQueryStringBuilder.cs
+++ b/Source/SurveyQueryStringBuilder.cs
@@ -1,6 +1,6 @@
//
// Engage: Survey
-// Copyright (c) 2004-2013
+// Copyright (c) 2004-2014
// by Engage Software ( http://www.engagesoftware.com )
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
diff --git a/Source/SurveyService.asmx.cs b/Source/SurveyService.asmx.cs
index 4243cf7..6b4dc25 100644
--- a/Source/SurveyService.asmx.cs
+++ b/Source/SurveyService.asmx.cs
@@ -1,6 +1,6 @@
//
// Engage: Survey
-// Copyright (c) 2004-2013
+// Copyright (c) 2004-2014
// by Engage Software ( http://www.engagesoftware.com )
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
diff --git a/Source/Util/XmlMergeWithNamespaceSupport.cs b/Source/Util/XmlMergeWithNamespaceSupport.cs
index f5d3874..52a2913 100644
--- a/Source/Util/XmlMergeWithNamespaceSupport.cs
+++ b/Source/Util/XmlMergeWithNamespaceSupport.cs
@@ -1,6 +1,6 @@
//
// Engage: Survey
-// Copyright (c) 2004-2013
+// Copyright (c) 2004-2014
// by Engage Software ( http://www.engagesoftware.com )
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
diff --git a/Source/Utility.cs b/Source/Utility.cs
index e85ef96..f779dfa 100644
--- a/Source/Utility.cs
+++ b/Source/Utility.cs
@@ -1,6 +1,6 @@
//
// Engage: Survey - http://www.engagesoftware.com
-// Copyright (c) 2004-2013
+// Copyright (c) 2004-2014
// by Engage Software ( http://www.engagesoftware.com )
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
diff --git a/Source/ViewSurvey.ascx.cs b/Source/ViewSurvey.ascx.cs
index 1f17c35..a6609a6 100644
--- a/Source/ViewSurvey.ascx.cs
+++ b/Source/ViewSurvey.ascx.cs
@@ -1,6 +1,6 @@
//
// Engage: Survey
-// Copyright (c) 2004-2013
+// Copyright (c) 2004-2014
// by Engage Software ( http://www.engagesoftware.com )
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
diff --git a/Source/packages.config b/Source/packages.config
new file mode 100644
index 0000000..8129cf7
--- /dev/null
+++ b/Source/packages.config
@@ -0,0 +1,5 @@
+
+
+
+
+
\ No newline at end of file
diff --git a/Source/web.config b/Source/web.config
new file mode 100644
index 0000000..81dbb0b
--- /dev/null
+++ b/Source/web.config
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- 