UNPKG

adxutil

Version:

Utilities tools for Askia Design eXtension

1,316 lines (1,061 loc) 183 kB
<?xml version="1.0"?> <doc> <assembly> <name>AskiaCore</name> </assembly> <members> <member name="T:AskiaCore.ContextFactory"> <summary> Factory to create a <see cref="T:AskiaCore.IContext"/> to access/edit survey </summary> </member> <member name="M:AskiaCore.ContextFactory.Create"> <summary> Create a new instance of <see cref="T:AskiaCore.IContext"/> </summary> <returns>A new context instance</returns> </member> <member name="T:AskiaCore.ICategory"> \brief %Category interface </member> <member name="P:AskiaCore.ICategory.Name"> \brief Name of the category </member> <member name="T:AskiaCore.ICategoryCollection"> \brief %Category collection </member> <member name="P:AskiaCore.ICategoryCollection.Count"> \brief Number of categories in the collection </member> <member name="P:AskiaCore.ICategoryCollection.Item(System.String)"> \brief Find a category by name </member> <member name="M:AskiaCore.ICategoryCollection.Create(System.String)"> \brief Create a category given its name </member> <member name="M:AskiaCore.ICategoryCollection.Remove(System.Int32)"> \brief Remove a category from the collection given its id </member> <member name="M:AskiaCore.ICategoryCollection.Remove(System.String)"> \brief Remove a category from the collection given its name </member> <member name="T:AskiaCore.ICategoryIterator"> \brief %Category iterator </member> <member name="T:AskiaCore.ICategoryRefCollection"> \brief %Category collection </member> <member name="P:AskiaCore.ICategoryRefCollection.Count"> \brief Number of categories in the collection </member> <member name="P:AskiaCore.ICategoryRefCollection.Item(System.Int32)"> \brief Find a category by id </member> <member name="P:AskiaCore.ICategoryRefCollection.Item(System.String)"> \brief Find a category by name </member> <member name="M:AskiaCore.ICategoryRefCollection.Add(System.Int32)"> \brief Add a category given its id </member> <member name="M:AskiaCore.ICategoryRefCollection.Add(System.String)"> \brief Add a category given its name </member> <member name="M:AskiaCore.ICategoryRefCollection.Remove(System.Int32)"> \brief Remove a category from the collection given its id </member> <member name="M:AskiaCore.ICategoryRefCollection.Remove(System.String)"> \brief Remove a category from the collection given its name </member> <member name="T:AskiaCore.IContext"> <summary> Provide a context for requests execution, it's required for many API requests. </summary> <example> <para>Create a new survey with one question</para> <code> using AskiaCore; namespace MyApp { public class MyProgram { static void Main() { // Initialize the database connection string (Where the survey will be stored) Persistent.InitDatabaseConnection("connectionstring", DatabaseTypes.PORTAL); // Create a new context IContext context = ContextFactory.Create(); context.UserId = 1; context.SessionId = "xxxxx-xxxxx-xxxxx-xxxxxx"; context.LanguageId = 2057; // Edit the survey with this language (English) // Create a new survey ISurvey survey = SurveyFactory.Create(context); survey.Name = "MySurvey"; survey.DefaultLanguageId = 2057; // English // Create the single closed question gender IQuestion gender = survey.Questions.Create(); gender.Shortcut = "gender"; gender.MainCaption ="What's your gender?"; gender.Type = QuestionType.Single; // Create responses IResponse man = gender.Responses.Create(); man.MainCaption = "Man"; IResponse woman = gender.Responses.Create(); woman.MainCaption = "Woman"; // Save all changes survey.SaveAll(); // Release the database connection Persistent.EndDatabaseConnection(); } } } </code> </example> </member> <member name="P:AskiaCore.IContext.UserId"> <summary> Id of the AskiaPortal user making the request </summary> </member> <member name="P:AskiaCore.IContext.SessionId"> <summary> Arbitrary session id in which in the request is made This session id should be the same for all requests made by a client session. </summary> <remarks>It's important to give the same session id for a better management of the undo/redo, logs etc...</remarks> </member> <member name="P:AskiaCore.IContext.LanguageId"> <summary> Id of the current survey language </summary> </member> <member name="T:AskiaCore.IControlRender"> <summary> Represents the result of the control rendering </summary> </member> <member name="P:AskiaCore.IControlRender.OutputId"> <summary> Id of the output that has been used </summary> </member> <member name="P:AskiaCore.IControlRender.Header"> <summary> Header part of the rendered control </summary> </member> <member name="P:AskiaCore.IControlRender.Placeholder"> <summary> Placeholder part of the rendered control </summary> </member> <member name="P:AskiaCore.IControlRender.Footer"> <summary> Footer part of the rendered control </summary> </member> <member name="P:AskiaCore.IControlRender.IsRendered"> <summary> Indicates if the control has been successfully rendered </summary> </member> <member name="P:AskiaCore.IControlRender.Errors"> <summary> Returns the collection of possible errors </summary> </member> <member name="P:AskiaCore.IControl.Name"> \brief Name of the control </member> <member name="P:AskiaCore.IControl.Config"> \brief XML Configuration of the control </member> <member name="P:AskiaCore.IControl.Data"> \brief Data contained within the file </member> <member name="M:AskiaCore.IControl.LoadFromDirectory(System.String)"> \brief Loads the control from a directory </member> <member name="M:AskiaCore.IControl.LoadFromFileAndExtract(System.String,System.String)"> \brief Loads the control from a file and extract its content to a directory </member> <member name="M:AskiaCore.IControl.LoadFromMemoryAndExtract(System.String)"> \brief Loads the control from memory and extracts its content to a directory </member> <member name="M:AskiaCore.IControl.RenderForQuestion(AskiaCore.ISurvey,AskiaCore.IInterview,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String})"> \brief Renderds the control for a given question of a given survey interview </member> <member name="T:AskiaCore.IControlCollection"> \brief %Control collection </member> <member name="P:AskiaCore.IControlCollection.Count"> \brief Number of controls in the collection </member> <member name="P:AskiaCore.IControlCollection.Item(System.String)"> \brief Find a control by name </member> <member name="M:AskiaCore.IControlCollection.Create(System.String)"> \brief Create a control given its name </member> <member name="M:AskiaCore.IControlCollection.Remove(System.Int32)"> \brief Remove a control from the collection given its id </member> <member name="M:AskiaCore.IControlCollection.Remove(System.String)"> \brief Remove a control from the collection given its name </member> <member name="T:AskiaCore.IControlIterator"> \brief %Control iterator </member> <member name="T:AskiaCore.IControlRefCollection"> \brief %IControl collection </member> <member name="P:AskiaCore.IControlRefCollection.Count"> \brief Number of controls in the collection </member> <member name="P:AskiaCore.IControlRefCollection.Item(System.Int32)"> \brief Find a control by id </member> <member name="P:AskiaCore.IControlRefCollection.Item(System.String)"> \brief Find a control by name </member> <member name="M:AskiaCore.IControlRefCollection.Create(System.String)"> \brief Create a control given its name </member> <member name="M:AskiaCore.IControlRefCollection.Remove(System.Int32)"> \brief Remove a control from the collection given its id </member> <member name="M:AskiaCore.IControlRefCollection.Remove(System.String)"> \brief Remove a control from the collection given its name </member> <member name="T:AskiaCore.ControlsFactory"> \brief %IControlsFactory </member> <member name="M:AskiaCore.ControlsFactory.GetControlsMap(AskiaCore.IContext)"> \brief Controls collection </member> <member name="M:AskiaCore.ControlsFactory.Create(AskiaCore.IContext)"> \brief Create a new control </member> <member name="T:AskiaCore.ElementType"> \brief Enumeration of the element type </member> <member name="T:AskiaCore.IElement"> \brief %Element interface </member> <member name="M:AskiaCore.IElement.IsReachable"> \brief Defines if the Eleemnt is reachable </member> <member name="P:AskiaCore.IElement.QuestionId"> \brief Id of the question related to the element </member> <member name="P:AskiaCore.IElement.ParentId"> \brief Id of the parent element </member> <member name="P:AskiaCore.IElement.Parent"> \brief Parent element </member> <member name="P:AskiaCore.IElement.Position"> \brief Position of the element </member> <member name="P:AskiaCore.IElement.Type"> \brief Type of the element </member> <member name="P:AskiaCore.IElement.ExtensionId"> \brief Id of the extension (control or page template) related to the element </member> <member name="M:AskiaCore.IElement.SetExtension(System.Int32)"> <summary> Set the id of extension depending on the type of the element (Control or Page Template) </summary> <param name="id">Id of the control or page template</param> <returns></returns> </member> <member name="P:AskiaCore.IElement.ExtensionProperties"> \brief Extension properties collection for the element </member> <member name="P:AskiaCore.IElement.ThemeProperties"> \brief Theme properties collection for the element </member> <member name="P:AskiaCore.IElement.BeforeStart"> \brief HTML code to inject before the element start </member> <member name="P:AskiaCore.IElement.AfterStart"> \brief HTML code to inject after the element start </member> <member name="P:AskiaCore.IElement.BeforeEnd"> \brief HTML code to inject before the element end </member> <member name="P:AskiaCore.IElement.AfterEnd"> \brief HTML code to inject after the element end </member> <member name="P:AskiaCore.IElement.Classes"> \brief Classes to add to the element </member> <member name="P:AskiaCore.IElement.Attributes"> \brief HTML attributes to add to the element </member> <member name="P:AskiaCore.IElement.Style"> \brief Style </member> <member name="M:AskiaCore.IElement.GetLanguageCaption(System.Int32)"> \brief Gets the caption text for a given language </member> <member name="M:AskiaCore.IElement.SetLanguageCaption(System.Int32,System.String)"> \brief Sets the caption text for a given language </member> <member name="P:AskiaCore.IElement.Children"> \brief Children elements collection for the element </member> <member name="P:AskiaCore.IElement.MediaElements"> \brief Media elements collection for the element </member> <member name="M:AskiaCore.IElement.RenderPage(AskiaCore.IInterview,System.String)"> \brief Render the corresponding page for the specified interview </member> <member name="M:AskiaCore.IElement.RenderControl(AskiaCore.IInterview,System.String)"> \brief Render the corresponding control for the specified interview </member> <member name="P:AskiaCore.IElement.PrevSibling"> \brief Previous sibling element </member> <member name="P:AskiaCore.IElement.PrevSiblingId"> \brief Previous sibling Id </member> <member name="P:AskiaCore.IElement.NextSibling"> \brief Next sibling element </member> <member name="P:AskiaCore.IElement.NextSiblingId"> \brief Next sibling Id </member> <member name="P:AskiaCore.IElement.FirstChild"> \brief First child element </member> <member name="P:AskiaCore.IElement.LastChild"> \brief Last child element </member> <member name="T:AskiaCore.IElementCollection"> \brief %Element collection </member> <member name="P:AskiaCore.IElementCollection.Count"> \brief Number of elements in the collection </member> <member name="M:AskiaCore.IElementCollection.GetById(System.Int32)"> \brief Get an element with the given id </member> <member name="M:AskiaCore.IElementCollection.GetByType(AskiaCore.ElementType)"> \brief Get the first element with the given type </member> <member name="M:AskiaCore.IElementCollection.Create(System.Int32)"> <summary> Creates a new child element at a given position </summary> <param name="position">Position at which the child element should be created</param> <returns>Returns the created entity</returns> </member> <member name="M:AskiaCore.IElementCollection.Remove(System.Int32)"> \brief Remove a element from the collection given its id </member> <member name="T:AskiaCore.IElementIterator"> \brief %Element iterator </member> <member name="T:AskiaCore.ErrorType"> <summary> Enumeration of error type </summary> </member> <member name="F:AskiaCore.ErrorType.Unknown"> <summary> Unknown error </summary> </member> <member name="F:AskiaCore.ErrorType.NoQuestionnaire"> <summary> Could not find the questionnaire </summary> </member> <member name="F:AskiaCore.ErrorType.NoControl"> <summary> Could not find the control </summary> </member> <member name="F:AskiaCore.ErrorType.NoPage"> <summary> Could not find the page </summary> </member> <member name="F:AskiaCore.ErrorType.MissingQuestion"> <summary> Missing question, could not find the specified question. <br/> TODO::Better explain in which case that occurs TODO::If related to ADX probably prefix it </summary> </member> <member name="F:AskiaCore.ErrorType.CannotLoadPageTemplate"> <summary> Could not load the specified page template </summary> </member> <member name="F:AskiaCore.ErrorType.CannotLoadControl"> <summary> Could not load the specified control </summary> </member> <member name="F:AskiaCore.ErrorType.Script"> <summary> Error in AskiaScript </summary> </member> <member name="F:AskiaCore.ErrorType.ScriptShortcut"> <summary> Error in AskiaScript <br/> TODO::Better explain in which case that occurs </summary> </member> <member name="F:AskiaCore.ErrorType.CaptionShortcut"> <summary> Error in shortcut caption <br/> TODO::Better explain in which case that occurs </summary> </member> <member name="F:AskiaCore.ErrorType.InfiniteLoop"> <summary> Possible infinite loop </summary> </member> <member name="F:AskiaCore.ErrorType.RunTime"> <summary> Runtime error. <br /> The AskiaScript compilation succeed but could not be evaluated at runtime </summary> </member> <member name="F:AskiaCore.ErrorType.InvalidLanguage"> <summary> Invalid language, <br /> TODO::Better explain in which case that occurs TODO::Maybe the language of the survey </summary> </member> <member name="F:AskiaCore.ErrorType.InvalidVersion"> <summary> Invalid version, <br /> TODO::Better explain in which case that occurs TODO::Maybe the scenario, in that case change the Version to Scenario </summary> </member> <member name="F:AskiaCore.ErrorType.ODBCStartQuery"> <summary> Could not execute SQL query, <br /> TODO::Better explain in which case that occurs </summary> </member> <member name="F:AskiaCore.ErrorType.ODBCImport"> <summary> Could no execute the SQL query to import data. <br /> TODO::Better explain in which case that occurs </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingProperty"> <summary> Missing ADX property. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingContent"> <summary> Missing ADX content. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxInvalidZip"> <summary> Invalid ADX file compression. <br /> The zip file is invalid. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxInvalidXMLFile"> <summary> Invalid ADX config XML file. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxInvalidSWFFile"> <summary> Invalid ADX Flash file. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingFile"> <summary> Could not retrieve the file associated with the ADX content. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxInvalidXML"> <summary> Invalid ADX config XML definition. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingCachedFile"> <summary> Could not find the dynamic file associated with the ADX content. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxNoOutput"> <summary> Could not find an ADX output. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxOutputConditionError"> <summary> Error while interpreting the condition of the ADX output. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxBinaryNoDynamic"> <summary> A binary file could not be dynamic in ADX. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxBinaryNeedsYield"> <summary> The `yield` node is require to define how to display arbitrary binary file in ADX. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxCannotCreateDirectory"> <summary> Unable to create the ADX directory. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxTextNoStaticOrShare"> <summary> Could not use the `Content.ToText()` method for ADX static/shared files. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingAskiaHeadTag"> <summary> Missing &lt;askia-head /&gt; tag in the ADX master page. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingAskiaFormTag"> <summary> Missing &lt;askia-form&gt; tag in the ADX master page. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingAskiaFormCloseTag"> <summary> Missing &lt;/askia-form&gt; close tag in the ADX master page. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingAskiaQuestionsTag"> <summary> Missing &lt;askia-questions /&gt; tag in the ADX master page. </summary> </member> <member name="F:AskiaCore.ErrorType.AdxMissingAskiaFootTag"> <summary> Missing &lt;askia-foot /&gt; tag in the ADX master page. </summary> </member> <member name="F:AskiaCore.ErrorType.InvalidQuestionId"> <summary> The specified question id is invalid </summary> </member> <member name="F:AskiaCore.ErrorType.InvalidQuestionPosition"> <summary> The specified question position is invalid </summary> </member> <member name="F:AskiaCore.ErrorType.InvalidRangeIdsOrder"> <summary> The order of IDs into the range are incorrect </summary> </member> <member name="F:AskiaCore.ErrorType.UnableToMoveQuestionsOrElements"> <summary> Could not move questions or elements </summary> </member> <member name="F:AskiaCore.ErrorType.UnableToIndentQuestionsOrElements"> <summary> Could not indent questions or elements </summary> </member> <member name="F:AskiaCore.ErrorType.UnableToUnindentQuestionsOrElements"> <summary> Could not unindent questions or elements </summary> </member> <member name="F:AskiaCore.ErrorType.UnableToSaveStructureModifications"> <summary> Could not save structure modifications </summary> </member> <member name="F:AskiaCore.ErrorType.InvalidElementId"> <summary> The specified element id is invalid </summary> </member> <member name="F:AskiaCore.ErrorType.UnmovableElementType"> <summary> The specified element type cannot be moved </summary> </member> <member name="F:AskiaCore.ErrorType.InvalidElementMove"> <summary> The specified element move is invalid </summary> </member> <member name="T:AskiaCore.IError"> <summary> Error returned by AskiaCore </summary> </member> <member name="P:AskiaCore.IError.Type"> <summary> Indicatas the type of the error </summary> </member> <member name="P:AskiaCore.IError.Code"> <summary> Internal error code, when available </summary> </member> <member name="P:AskiaCore.IError.Source"> <summary> Source context of the error, when available. </summary> </member> <member name="P:AskiaCore.IError.StartingPosition"> <summary> Start position of the error in the source context when available. </summary> </member> <member name="P:AskiaCore.IError.Length"> <summary> Length of the error in the source context </summary> </member> <member name="P:AskiaCore.IError.ExtraDescription"> <summary> Additional information concerning the error </summary> </member> <member name="T:AskiaCore.IExtensionProperty"> <summary> Represents the key/value pair extension (ADX) property </summary> </member> <member name="P:AskiaCore.IExtensionProperty.Name"> <summary> Name of the property </summary> </member> <member name="P:AskiaCore.IExtensionProperty.Value"> <summary> Value assign to the property </summary> </member> <member name="P:AskiaCore.IExtensionProperty.IsInherited"> <summary> Tells if the property is inherited or set at the current level </summary> </member> <member name="T:AskiaCore.IExtensionPropertyCollection"> <summary> Collection of the extension (ADX) property </summary> </member> <member name="P:AskiaCore.IExtensionPropertyCollection.Count"> <summary> Returns the number of properties in the collection </summary> </member> <member name="P:AskiaCore.IExtensionPropertyCollection.Item(System.String)"> <summary> Returns the value associated with the specified property name </summary> <param name="name">Name of the property to read</param> <returns>Return null if the property was not found</returns> </member> <member name="M:AskiaCore.IExtensionPropertyCollection.Contains(System.String)"> <summary> Indicates if the collection contains the specified property </summary> <param name="name">Name of the property to search</param> <returns>True when the collection contains the specified property, otherwize false</returns> </member> <member name="M:AskiaCore.IExtensionPropertyCollection.Create(System.String,System.String)"> <summary> Create a property using the specified name and value </summary> <remarks> If the name of the property already exist, this method override it's value </remarks> <param name="name">Name of the property to create</param> <param name="value">Value of the new create property</param> <returns>The property that has been created</returns> </member> <member name="M:AskiaCore.IExtensionPropertyCollection.Remove(System.String)"> <summary> Remove the specified property from the collection </summary> <param name="name">Name of the property to remove</param> <returns>Returns true if the property was found and removed</returns> </member> <member name="M:AskiaCore.IExtensionPropertyCollection.Clear"> <summary> Remove all properties from the collection </summary> </member> <member name="M:AskiaCore.IExtensionPropertyCollection.GetResolvedCascadingValues"> <summary> Get all properties including the ones resolving to default values </summary> </member> <member name="T:AskiaCore.IExtensionPropertyIterator"> <summary> Iterator over the collection of extension properties </summary> </member> <member name="T:AskiaCore.IInterviewWebInformation"> <summary> Information of the web browser doing the interview </summary> <seealso cref="P:AskiaCore.IInterview.WebInformation"/> </member> <member name="P:AskiaCore.IInterviewWebInformation.Identity"> <summary> Identity of the web browser </summary> <example> <code> // The above string is on a single line // carriage return are only use for readability "name:\"Chrome\", version:\"50.0.2661.102\", os:\"Windows\", mobile:false, tablet:false, userAgent:\"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36\", timeOffset:2" </code> </example> </member> <member name="P:AskiaCore.IInterviewWebInformation.Resolution"> <summary> Resolution of the web browser's device </summary> <example> <code> // The above string is on a single line // carriage return are only use for readability "screen-availWidth:2560, screen-availHeight:1334, screen-width:2560, screen-height:1440, screen-colorDepth:24, window-width:1708, window-height:1130" </code> </example> </member> <member name="P:AskiaCore.IInterviewWebInformation.Capabilities"> <summary> Browser capabilities </summary> <example> <code> // The above string is on a single line // carriage return are only use for readability "Javascript:true, Flash:"21.0.0.0",QuickTime:false,WindowsMediaPlayer:false,Silverlight:false, AdobeReader:false,RealPlayer:false, flexbox:true,flexboxlegacy:true, canvas:true,canvastext:true,webgl:true, touch:false, geolocation:true, postmessage:true, websqldatabase:true,indexeddb:true, hashchange:true,history:true, draganddrop:true, websockets:true, rgba:true,hsla:true, multiplebgs:true,backgroundsize:true, borderimage:true,borderradius:true, boxshadow:true,textshadow:true, opacity:true, cssanimations:true,csscolumns:true,cssgradients:true, cssreflections:true,csstransforms:true,csstransforms3d:true, csstransitions:true, fontface:true,generatedcontent:true, video:true,ogg:true,h264:true,webm:true, audio:true,mp3:true,wav:true,m4a:true, localstorage:true,sessionstorage:true, webworkers:true, applicationcache:true, svg:true,inlinesvg:true,smil:true,svgclippaths:true, autocomplete:true,autofocus:true, list:true,placeholder:true,max:true,min:true, multiple:true,pattern:true,required:true,step:true, search:true,tel:true,url:true,email:true, datetime:false,date:true,month:true,week:true,time:false, datetime-local:true,number:true,range:true,color:true, battery:false,lowbattery:false, cookies:true, bgpositionshorthand:true,bgpositionxy:true,bgrepeatround:false, bgrepeatspace:false,bgsizecover:true, boxsizing:true, csscalc:true,cubicbezierrange:true, display-runin:false,display-table:true, cssfilters:true,csshyphens:false,softhyphens:true,softhyphensfind:true, lastchild:true,cssmask:false, mediaqueries:true,object-fit:true, overflowscrolling:false, pointerevents:true,csspositionsticky:false,cssremunit:true, regions:false,cssresize:true,cssscrollbar:true, subpixelfont:true,supports:true, userselect:false,classlist:true, createelement-attrs:false,datalistelem:true, details:true,outputelem:true, progressbar:true,meter:true,ruby:true, texttrackapi:true,track:true, strictmode:true,devicemotion:true,deviceorientation:true, filereader:true,fileinput:true,formattribute:true, filesystem:true,speechinput:false, formvalidationapi:true,formvalidationmessage:true, formvalidation:true,fullscreen:true, ie8compat:false, json:true,mathml:false,unicode:true, userdata:false,websocketsbinary:true, exif-orientation:false" </code> </example> </member> <member name="T:AskiaCore.IInterviewMethodResult"> <summary> Represents the result of many <see cref="T:AskiaCore.IInterview"/> methods </summary> </member> <member name="P:AskiaCore.IInterviewMethodResult.IsCompleted"> <summary> Indicates if the interview is completed </summary> </member> <!-- Badly formed XML comment ignored for member "T:AskiaCore.IInterview" --> <member name="M:AskiaCore.IInterview.MoveOn(System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Try to save the answers and to move on the next visible page </summary> <remarks> <para> This method doesn't necesseraly move to the page that follow the current page.<br /> According to the specified parameters, this method could:<br/> - stay on the same page<br/> - go to the previous visible page<br/> - go to the next visible page<br/> </para> <para> Notice that some routings and properties could redirect the respondent to a previous or to a far next page. </para> </remarks> <param name="parameters">Respondent answers and web parameters</param> <returns>Returns <see cref="!:IInterviewMethodResult.Success"/> until a page is accessible</returns> </member> <member name="P:AskiaCore.IInterview.CurrentPage"> <summary> Returns the current interview page element </summary> </member> <member name="P:AskiaCore.IInterview.CurrentPosition"> <summary> Returns the current position of the interview </summary> </member> <member name="P:AskiaCore.IInterview.PreviousPosition"> <summary> Returns the previous position of the interview </summary> </member> <member name="P:AskiaCore.IInterview.PreviousPage"> <summary> Returns the previous interview page element </summary> </member> <member name="P:AskiaCore.IInterview.NextPosition"> <summary> Returns the next possible position of the interview </summary> </member> <member name="P:AskiaCore.IInterview.NextPage"> <summary> Returns the next possible interview page element </summary> </member> <member name="P:AskiaCore.IInterview.WebInformation"> <summary> Returns the web browser information </summary> </member> <member name="T:AskiaCore.ILanguage"> \brief %Language interface </member> <member name="P:AskiaCore.ILanguage.Id"> \brief Id of the language </member> <member name="P:AskiaCore.ILanguage.LocalName"> \brief LocalName of the language </member> <member name="T:AskiaCore.ILanguageCollection"> \brief %Language collection </member> <member name="P:AskiaCore.ILanguageCollection.Count"> \brief Number of languages in the collection </member> <member name="P:AskiaCore.ILanguageCollection.Item(System.Int32)"> \brief Find a language by id </member> <member name="M:AskiaCore.ILanguageCollection.Add(AskiaCore.ILanguage)"> \brief Creates a new language in the collection given its name </member> <member name="M:AskiaCore.ILanguageCollection.Remove(System.Int32)"> \brief Remove a language from the collection given its id </member> <member name="T:AskiaCore.ILanguageIterator"> \brief %Language iterator </member> <member name="T:AskiaCore.LanguageFactory"> \brief %Language factory </member> <member name="M:AskiaCore.LanguageFactory.GetAllLanguages"> \brief Get all existing languages </member> <member name="T:AskiaCore.IMedia"> \brief %Media interface </member> <member name="P:AskiaCore.IMedia.IsSystem"> \brief Indicates if the media is a system media </member> <member name="P:AskiaCore.IMedia.Name"> \brief Name </member> <member name="P:AskiaCore.IMedia.Query"> \brief Query </member> <member name="P:AskiaCore.IMedia.CustomProperties"> \brief Custom properties </member> <member name="T:AskiaCore.IMediaCollection"> \brief %Media collection </member> <member name="P:AskiaCore.IMediaCollection.Count"> \brief Number of media in the collection </member> <member name="M:AskiaCore.IMediaCollection.Remove(System.Int32)"> \brief Remove a media from the collection given its id </member> <member name="T:AskiaCore.IMediaIterator"> \brief %Media iterator </member> <member name="T:AskiaCore.MediaElementUnit"> \brief Enumeration of the media element units </member> <member name="T:AskiaCore.IMediaElement"> \brief %MediaElement interface </member> <member name="P:AskiaCore.IMediaElement.Id"> \brief Id of the record </member> <member name="P:AskiaCore.IMediaElement.LastError"> \brief Last error that occurred </member> <member name="M:AskiaCore.IMediaElement.IsLoaded"> \brief Checks if the record is loaded from the database </member> <member name="M:AskiaCore.IMediaElement.Save"> \brief Saves the record </member> <member name="M:AskiaCore.IMediaElement.ReLoad"> \brief ReLoads the record </member> <member name="P:AskiaCore.IMediaElement.ElementId"> \brief Id of the corresponding element </member> <member name="P:AskiaCore.IMediaElement.MediaId"> \brief Id of the corresponding media </member> <member name="P:AskiaCore.IMediaElement.MarginLeft"> \brief Left margin of the media element in pixel </member> <member name="P:AskiaCore.IMediaElement.MarginRight"> \brief Right margin of the media element in pixel </member> <member name="P:AskiaCore.IMediaElement.MarginTop"> \brief Top margin of the media element in pixel </member> <member name="P:AskiaCore.IMediaElement.MarginBottom"> \brief Bottom margin of the media element in pixel </member> <member name="P:AskiaCore.IMediaElement.Width"> \brief Width value of the media element </member> <member name="P:AskiaCore.IMediaElement.WidthUnit"> \brief Unit of the media element's width </member> <member name="P:AskiaCore.IMediaElement.MinHeight"> \brief Minimum height of the media element </member> <member name="P:AskiaCore.IMediaElement.MaxHeight"> \brief Maximum height of the media element </member> <member name="P:AskiaCore.IMediaElement.IsHorizontal"> \brief Indicates if the media element is horizontal </member> <member name="P:AskiaCore.IMediaElement.Overflow"> \brief Specifices the overflow value of the media element </member> <member name="P:AskiaCore.IMediaElement.IsHidden"> \brief Indicates if the media element is hidden </member> <member name="P:AskiaCore.IMediaElement.Style"> \brief Additional styles for the media eleemnts </member> <member name="P:AskiaCore.IMediaElement.CustomProperties"> \brief Custom properties for the media element </member> <member name="T:AskiaCore.IMediaElementCollection"> \brief %MediaElement collection </member> <member name="P:AskiaCore.IMediaElementCollection.Count"> \brief Number of media elements in the collection </member> <member name="M:AskiaCore.IMediaElementCollection.Create(System.Int32)"> \brief Create a media element given its media id </member> <member name="M:AskiaCore.IMediaElementCollection.GetByMediaId(System.Int32)"> \brief Retrieves the media element associated to the given media id </member> <member name="T:AskiaCore.IMediaElementIterator"> \brief %MediaElement iterator </member> <member name="T:AskiaCore.IPageRender"> <summary> Represents the result of the page rendering </summary> </member> <member name="P:AskiaCore.IPageRender.OutputId"> <summary> Id of the output that has been used </summary> </member> <member name="P:AskiaCore.IPageRender.Html"> <summary> Full HTML code of the rendered page (including head, form, foot) </summary> </member> <member name="P:AskiaCore.IPageRender.Header"> <summary> Header section of the HTML code of the rendered page </summary> </member> <member name="P:AskiaCore.IPageRender.Form"> <summary> Form section of the HTML code of the rendered page </summary> </member> <member name="P:AskiaCore.IPageRen