/usr/share/doc/rt4-doc-html/RT/CustomField.html is in rt4-doc-html 4.0.19-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 | <ul id="index">
<li>
<ul>
<li><a href="#AddRights-RIGHT-DESCRIPTION">AddRights RIGHT, DESCRIPTION [, ...]</a></li>
<li><a href="#RightCategories">RightCategories</a></li>
<li><a href="#AddRightCategories-RIGHT-CATEGORY">AddRightCategories RIGHT, CATEGORY [, ...]</a></li>
</ul>
</li>
<li><a href="#NAME">NAME</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#CORE-METHODS">'CORE' METHODS</a>
<ul>
<li><a href="#Create-PARAMHASH">Create PARAMHASH</a></li>
<li><a href="#Load-ID-NAME">Load ID/NAME</a></li>
<li><a href="#LoadByName-Queue-QUEUEID-Name-NAME">LoadByName (Queue => QUEUEID, Name => NAME)</a></li>
<li><a href="#Custom-field-values">Custom field values</a>
<ul>
<li><a href="#Values-FIELD">Values FIELD</a></li>
<li><a href="#AddValue-HASH">AddValue HASH</a></li>
<li><a href="#DeleteValue-ID">DeleteValue ID</a></li>
</ul>
</li>
<li><a href="#ValidateQueue-Queue">ValidateQueue Queue</a></li>
<li><a href="#ValidateQueue-Queue1">ValidateQueue Queue</a></li>
<li><a href="#Types">Types</a></li>
<li><a href="#IsSelectionType">IsSelectionType</a></li>
<li><a href="#IsExternalValues">IsExternalValues</a></li>
<li><a href="#FriendlyType-TYPE-MAX_VALUES">FriendlyType [TYPE, MAX_VALUES]</a></li>
<li><a href="#ValidateType-TYPE">ValidateType TYPE</a></li>
<li><a href="#SetPattern-STRING">SetPattern STRING</a></li>
<li><a href="#IsValidRegex-Str-regex-returns-Bool-success-Str-msg">_IsValidRegex(Str $regex) returns (Bool $success, Str $msg)</a></li>
<li><a href="#SingleValue">SingleValue</a></li>
<li><a href="#CurrentUserHasRight-RIGHT">CurrentUserHasRight RIGHT</a></li>
<li><a href="#ACLEquivalenceObjects">ACLEquivalenceObjects</a></li>
<li><a href="#ContextObject-and-SetContextObject">ContextObject and SetContextObject</a></li>
<li><a href="#LoadContextObject">LoadContextObject</a></li>
<li><a href="#ValidateContextObject">ValidateContextObject</a></li>
<li><a href="#Value">_Value</a></li>
<li><a href="#SetDisabled">SetDisabled</a></li>
<li><a href="#SetTypeComposite">SetTypeComposite</a></li>
<li><a href="#TypeComposite">TypeComposite</a></li>
<li><a href="#TypeComposites">TypeComposites</a></li>
<li><a href="#RenderType">RenderType</a></li>
<li><a href="#SetRenderType-TYPE">SetRenderType TYPE</a></li>
<li><a href="#DefaultRenderType-TYPE-COMPOSITE">DefaultRenderType [TYPE COMPOSITE]</a></li>
<li><a href="#HasRenderTypes-TYPE_COMPOSITE">HasRenderTypes [TYPE_COMPOSITE]</a></li>
<li><a href="#RenderTypes-TYPE-COMPOSITE">RenderTypes [TYPE COMPOSITE]</a></li>
<li><a href="#SetLookupType">SetLookupType</a></li>
<li><a href="#LookupTypes">LookupTypes</a></li>
<li><a href="#FriendlyLookupType">FriendlyLookupType</a></li>
</ul>
</li>
<li><a href="#RecordClassFromLookupType">RecordClassFromLookupType</a></li>
<li><a href="#ObjectTypeFromLookupType">ObjectTypeFromLookupType</a></li>
<li><a href="#ApplyGlobally">ApplyGlobally</a></li>
<li><a href="#AppliedTo">AppliedTo</a></li>
<li><a href="#NotAppliedTo">NotAppliedTo</a>
<ul>
<li><a href="#IsApplied">IsApplied</a></li>
<li><a href="#AddToObject-OBJECT">AddToObject OBJECT</a></li>
<li><a href="#RemoveFromObject-OBJECT">RemoveFromObject OBJECT</a></li>
<li><a href="#AddValueForObject-HASH">AddValueForObject HASH</a></li>
<li><a href="#MatchPattern-STRING">MatchPattern STRING</a></li>
<li><a href="#FriendlyPattern">FriendlyPattern</a></li>
<li><a href="#DeleteValueForObject-HASH">DeleteValueForObject HASH</a></li>
<li><a href="#ValuesForObject-OBJECT">ValuesForObject OBJECT</a></li>
<li><a href="#ForObjectType-PATH-FRIENDLYNAME">_ForObjectType PATH FRIENDLYNAME</a></li>
<li><a href="#IncludeContentForValue-VALUE-and-SetIncludeContentForValue">IncludeContentForValue [VALUE] (and SetIncludeContentForValue)</a></li>
<li><a href="#LinkValueTo-VALUE-and-SetLinkValueTo">LinkValueTo [VALUE] (and SetLinkValueTo)</a></li>
<li><a href="#URLTemplate-NAME-VALUE">_URLTemplate NAME [VALUE]</a></li>
<li><a href="#id">id</a></li>
<li><a href="#Name">Name</a></li>
<li><a href="#SetName-VALUE">SetName VALUE</a></li>
<li><a href="#Type">Type</a></li>
<li><a href="#SetType-VALUE">SetType VALUE</a></li>
<li><a href="#RenderType1">RenderType</a></li>
<li><a href="#SetRenderType-VALUE">SetRenderType VALUE</a></li>
<li><a href="#MaxValues">MaxValues</a></li>
<li><a href="#SetMaxValues-VALUE">SetMaxValues VALUE</a></li>
<li><a href="#Pattern">Pattern</a></li>
<li><a href="#SetPattern-VALUE">SetPattern VALUE</a></li>
<li><a href="#Repeated">Repeated</a></li>
<li><a href="#SetRepeated-VALUE">SetRepeated VALUE</a></li>
<li><a href="#BasedOn">BasedOn</a></li>
<li><a href="#SetBasedOn-VALUE">SetBasedOn VALUE</a></li>
<li><a href="#Description">Description</a></li>
<li><a href="#SetDescription-VALUE">SetDescription VALUE</a></li>
<li><a href="#SortOrder">SortOrder</a></li>
<li><a href="#SetSortOrder-VALUE">SetSortOrder VALUE</a></li>
<li><a href="#LookupType">LookupType</a></li>
<li><a href="#SetLookupType-VALUE">SetLookupType VALUE</a></li>
<li><a href="#Creator">Creator</a></li>
<li><a href="#Created">Created</a></li>
<li><a href="#LastUpdatedBy">LastUpdatedBy</a></li>
<li><a href="#LastUpdated">LastUpdated</a></li>
<li><a href="#Disabled">Disabled</a></li>
<li><a href="#SetDisabled-VALUE">SetDisabled VALUE</a></li>
</ul>
</li>
</ul>
<h2 id="AddRights-RIGHT-DESCRIPTION"><a href="#___top">AddRights <code>RIGHT</code>, <code>DESCRIPTION</code> [, ...]</a></h2>
<p>Adds the given rights to the list of possible rights. This method should be called during server startup, not at runtime.</p>
<h2 id="RightCategories"><a href="#___top">RightCategories</a></h2>
<p>Returns a hashref where the keys are rights for this type of object and the values are the category (General, Staff, Admin) the right falls into.</p>
<h2 id="AddRightCategories-RIGHT-CATEGORY"><a href="#___top">AddRightCategories <code>RIGHT</code>, <code>CATEGORY</code> [, ...]</a></h2>
<p>Adds the given right and category pairs to the list of right categories. This method should be called during server startup, not at runtime.</p>
<h1 id="NAME"><a href="#___top">NAME</a></h1>
<pre><code> RT::CustomField_Overlay - overlay for RT::CustomField</code></pre>
<h1 id="DESCRIPTION"><a href="#___top">DESCRIPTION</a></h1>
<h1 id="CORE-METHODS"><a href="#___top">'CORE' METHODS</a></h1>
<h2 id="Create-PARAMHASH"><a href="#___top">Create PARAMHASH</a></h2>
<p>Create takes a hash of values and creates a row in the database:</p>
<pre><code> varchar(200) 'Name'.
varchar(200) 'Type'.
int(11) 'MaxValues'.
varchar(255) 'Pattern'.
smallint(6) 'Repeated'.
varchar(255) 'Description'.
int(11) 'SortOrder'.
varchar(255) 'LookupType'.
smallint(6) 'Disabled'.</code></pre>
<p><code>LookupType</code> is generally the result of either <code>RT::Ticket-</code>CustomFieldLookupType> or <code>RT::Transaction-</code>CustomFieldLookupType>.</p>
<h2 id="Load-ID-NAME"><a href="#___top">Load ID/NAME</a></h2>
<p>Load a custom field. If the value handed in is an integer, load by custom field ID. Otherwise, Load by name.</p>
<h2 id="LoadByName-Queue-QUEUEID-Name-NAME"><a href="#___top">LoadByName (Queue => QUEUEID, Name => NAME)</a></h2>
<p>Loads the Custom field named NAME.</p>
<p>Will load a Disabled Custom Field even if there is a non-disabled Custom Field with the same Name.</p>
<p>If a Queue parameter is specified, only look for ticket custom fields tied to that Queue.</p>
<p>If the Queue parameter is '0', look for global ticket custom fields.</p>
<p>If no queue parameter is specified, look for any and all custom fields with this name.</p>
<p>BUG/TODO, this won't let you specify that you only want user or group CFs.</p>
<h2 id="Custom-field-values"><a href="#___top">Custom field values</a></h2>
<h3 id="Values-FIELD"><a href="#___top">Values FIELD</a></h3>
<p>Return a object (collection) of all acceptable values for this Custom Field. Class of the object can vary and depends on the return value of the <code>ValuesClass</code> method.</p>
<h3 id="AddValue-HASH"><a href="#___top">AddValue HASH</a></h3>
<p>Create a new value for this CustomField. Takes a paramhash containing the elements Name, Description and SortOrder</p>
<h3 id="DeleteValue-ID"><a href="#___top">DeleteValue ID</a></h3>
<p>Deletes a value from this custom field by id.</p>
<p>Does not remove this value for any article which has had it selected</p>
<h2 id="ValidateQueue-Queue"><a href="#___top">ValidateQueue Queue</a></h2>
<p>Make sure that the name specified is valid</p>
<h2 id="ValidateQueue-Queue1"><a href="#___top">ValidateQueue Queue</a></h2>
<p>Make sure that the queue specified is a valid queue name</p>
<h2 id="Types"><a href="#___top">Types</a></h2>
<p>Retuns an array of the types of CustomField that are supported</p>
<h2 id="IsSelectionType"><a href="#___top">IsSelectionType</a></h2>
<p>Retuns a boolean value indicating whether the <code>Values</code> method makes sense to this Custom Field.</p>
<h2 id="IsExternalValues"><a href="#___top">IsExternalValues</a></h2>
<h2 id="FriendlyType-TYPE-MAX_VALUES"><a href="#___top">FriendlyType [TYPE, MAX_VALUES]</a></h2>
<p>Returns a localized human-readable version of the custom field type. If a custom field type is specified as the parameter, the friendly type for that type will be returned</p>
<h2 id="ValidateType-TYPE"><a href="#___top">ValidateType TYPE</a></h2>
<p>Takes a single string. returns true if that string is a value type of custom field</p>
<h2 id="SetPattern-STRING"><a href="#___top">SetPattern STRING</a></h2>
<p>Takes a single string representing a regular expression. Performs basic validation on that regex, and sets the <code>Pattern</code> field for the CF if it is valid.</p>
<h2 id="IsValidRegex-Str-regex-returns-Bool-success-Str-msg"><a href="#___top">_IsValidRegex(Str $regex) returns (Bool $success, Str $msg)</a></h2>
<p>Tests if the string contains an invalid regex.</p>
<h2 id="SingleValue"><a href="#___top">SingleValue</a></h2>
<p>Returns true if this CustomField only accepts a single value. Returns false if it accepts multiple values</p>
<h2 id="CurrentUserHasRight-RIGHT"><a href="#___top">CurrentUserHasRight RIGHT</a></h2>
<p>Helper function to call the custom field's queue's CurrentUserHasRight with the passed in args.</p>
<h2 id="ACLEquivalenceObjects"><a href="#___top">ACLEquivalenceObjects</a></h2>
<p>Returns list of objects via which users can get rights on this custom field. For custom fields these objects can be set using <a href="#ContextObject-and-SetContextObject">ContextObject</a>.</p>
<h2 id="ContextObject-and-SetContextObject"><a href="#___top">ContextObject and SetContextObject</a></h2>
<p>Set or get a context for this object. It can be ticket, queue or another object this CF applies to. Used for ACL control, for example SeeCustomField can be granted on queue level to allow people to see all fields applied to the queue.</p>
<h2 id="LoadContextObject"><a href="#___top">LoadContextObject</a></h2>
<p>Takes an Id for a Context Object and loads the right kind of RT::Object for this particular Custom Field (based on the LookupType) and returns it. This is a good way to ensure you don't try to use a Queue as a Context Object on a User Custom Field.</p>
<h2 id="ValidateContextObject"><a href="#___top">ValidateContextObject</a></h2>
<p>Ensure that a given ContextObject applies to this Custom Field. For custom fields that are assigned to Queues or to Classes, this checks that the Custom Field is actually applied to that objects. For Global Custom Fields, it returns true as long as the Object is of the right type, because you may be using your permissions on a given Queue of Class to see a Global CF. For CFs that are only applied Globally, you don't need a ContextObject.</p>
<h2 id="Value"><a href="#___top">_Value</a></h2>
<p>Takes the name of a table column. Returns its value as a string, if the user passes an ACL check</p>
<h2 id="SetDisabled"><a href="#___top">SetDisabled</a></h2>
<p>Takes a boolean. 1 will cause this custom field to no longer be avaialble for objects. 0 will re-enable this field.</p>
<h2 id="SetTypeComposite"><a href="#___top">SetTypeComposite</a></h2>
<p>Set this custom field's type and maximum values as a composite value</p>
<h2 id="TypeComposite"><a href="#___top">TypeComposite</a></h2>
<p>Returns a composite value composed of this object's type and maximum values</p>
<h2 id="TypeComposites"><a href="#___top">TypeComposites</a></h2>
<p>Returns an array of all possible composite values for custom fields.</p>
<h2 id="RenderType"><a href="#___top">RenderType</a></h2>
<p>Returns the type of form widget to render for this custom field. Currently this only affects fields which return true for <a href="#HasRenderTypes">"HasRenderTypes"</a>.</p>
<h2 id="SetRenderType-TYPE"><a href="#___top">SetRenderType TYPE</a></h2>
<p>Sets this custom field's render type.</p>
<h2 id="DefaultRenderType-TYPE-COMPOSITE"><a href="#___top">DefaultRenderType [TYPE COMPOSITE]</a></h2>
<p>Returns the default render type for this custom field's type or the TYPE COMPOSITE specified as an argument.</p>
<h2 id="HasRenderTypes-TYPE_COMPOSITE"><a href="#___top">HasRenderTypes [TYPE_COMPOSITE]</a></h2>
<p>Returns a boolean value indicating whether the <a href="#RenderTypes">"RenderTypes"</a> and <a href="#RenderType">"RenderType"</a> methods make sense for this custom field.</p>
<p>Currently true only for type <code>Select</code>.</p>
<h2 id="RenderTypes-TYPE-COMPOSITE"><a href="#___top">RenderTypes [TYPE COMPOSITE]</a></h2>
<p>Returns the valid render types for this custom field's type or the TYPE COMPOSITE specified as an argument.</p>
<h2 id="SetLookupType"><a href="#___top">SetLookupType</a></h2>
<p>Autrijus: care to doc how LookupTypes work?</p>
<h2 id="LookupTypes"><a href="#___top">LookupTypes</a></h2>
<p>Returns an array of LookupTypes available</p>
<h2 id="FriendlyLookupType"><a href="#___top">FriendlyLookupType</a></h2>
<p>Returns a localized description of the type of this custom field</p>
<h1 id="RecordClassFromLookupType"><a href="#___top">RecordClassFromLookupType</a></h1>
<p>Returns the type of Object referred to by ObjectCustomFields' ObjectId column</p>
<p>Optionally takes a LookupType to use instead of using the value on the loaded record. In this case, the method may be called on the class instead of an object.</p>
<h1 id="ObjectTypeFromLookupType"><a href="#___top">ObjectTypeFromLookupType</a></h1>
<p>Returns the ObjectType used in ObjectCustomFieldValues rows for this CF</p>
<p>Optionally takes a LookupType to use instead of using the value on the loaded record. In this case, the method may be called on the class instead of an object.</p>
<h1 id="ApplyGlobally"><a href="#___top">ApplyGlobally</a></h1>
<p>Certain custom fields (users, groups) should only be applied globally but rather than regexing in code for LookupType =~ RT::Queue, we'll codify the rules here.</p>
<h1 id="AppliedTo"><a href="#___top">AppliedTo</a></h1>
<p>Returns collection with objects this custom field is applied to. Class of the collection depends on <a href="#LookupType">"LookupType"</a>. See all <a href="#NotAppliedTo">"NotAppliedTo"</a> .</p>
<p>Doesn't takes into account if object is applied globally.</p>
<h1 id="NotAppliedTo"><a href="#___top">NotAppliedTo</a></h1>
<p>Returns collection with objects this custom field is not applied to. Class of the collection depends on <a href="#LookupType">"LookupType"</a>. See all <a href="#AppliedTo">"AppliedTo"</a> .</p>
<p>Doesn't takes into account if object is applied globally.</p>
<h2 id="IsApplied"><a href="#___top">IsApplied</a></h2>
<p>Takes object id and returns corresponding <a href="../../../rt/latest/RT/ObjectCustomField.html">RT::ObjectCustomField</a> record if this custom field is applied to the object. Use 0 to check if custom field is applied globally.</p>
<h2 id="AddToObject-OBJECT"><a href="#___top">AddToObject OBJECT</a></h2>
<p>Add this custom field as a custom field for a single object, such as a queue or group.</p>
<p>Takes an object</p>
<h2 id="RemoveFromObject-OBJECT"><a href="#___top">RemoveFromObject OBJECT</a></h2>
<p>Remove this custom field for a single object, such as a queue or group.</p>
<p>Takes an object</p>
<h2 id="AddValueForObject-HASH"><a href="#___top">AddValueForObject HASH</a></h2>
<p>Adds a custom field value for a record object of some kind. Takes a param hash of</p>
<p>Required:</p>
<pre><code> Object
Content</code></pre>
<p>Optional:</p>
<pre><code> LargeContent
ContentType</code></pre>
<h2 id="MatchPattern-STRING"><a href="#___top">MatchPattern STRING</a></h2>
<p>Tests the incoming string against the Pattern of this custom field object and returns a boolean; returns true if the Pattern is empty.</p>
<h2 id="FriendlyPattern"><a href="#___top">FriendlyPattern</a></h2>
<p>Prettify the pattern of this custom field, by taking the text in <code>(?#text)</code> and localizing it.</p>
<h2 id="DeleteValueForObject-HASH"><a href="#___top">DeleteValueForObject HASH</a></h2>
<p>Deletes a custom field value for a ticket. Takes a param hash of Object and Content</p>
<p>Returns a tuple of (STATUS, MESSAGE). If the call succeeded, the STATUS is true. otherwise it's false</p>
<h2 id="ValuesForObject-OBJECT"><a href="#___top">ValuesForObject OBJECT</a></h2>
<p>Return an <a href="../../../rt/latest/RT/ObjectCustomFieldValues.html">RT::ObjectCustomFieldValues</a> object containing all of this custom field's values for OBJECT</p>
<h2 id="ForObjectType-PATH-FRIENDLYNAME"><a href="#___top">_ForObjectType PATH FRIENDLYNAME</a></h2>
<p>Tell RT that a certain object accepts custom fields</p>
<p>Examples:</p>
<pre><code> 'RT::Queue-RT::Ticket' => "Tickets", # loc
'RT::Queue-RT::Ticket-RT::Transaction' => "Ticket Transactions", # loc
'RT::User' => "Users", # loc
'RT::Group' => "Groups", # loc
'RT::Queue' => "Queues", # loc</code></pre>
<p>This is a class method.</p>
<h2 id="IncludeContentForValue-VALUE-and-SetIncludeContentForValue"><a href="#___top">IncludeContentForValue [VALUE] (and SetIncludeContentForValue)</a></h2>
<p>Gets or sets the <code>IncludeContentForValue</code> for this custom field. RT uses this field to automatically include content into the user's browser as they display records with custom fields in RT.</p>
<h2 id="LinkValueTo-VALUE-and-SetLinkValueTo"><a href="#___top">LinkValueTo [VALUE] (and SetLinkValueTo)</a></h2>
<p>Gets or sets the <code>LinkValueTo</code> for this custom field. RT uses this field to make custom field values into hyperlinks in the user's browser as they display records with custom fields in RT.</p>
<h2 id="URLTemplate-NAME-VALUE"><a href="#___top">_URLTemplate NAME [VALUE]</a></h2>
<p>With one argument, returns the _URLTemplate named <code>NAME</code>, but only if the current user has the right to see this custom field.</p>
<p>With two arguments, attemptes to set the relevant template value.</p>
<h2 id="id"><a href="#___top">id</a></h2>
<p>Returns the current value of id. (In the database, id is stored as int(11).)</p>
<h2 id="Name"><a href="#___top">Name</a></h2>
<p>Returns the current value of Name. (In the database, Name is stored as varchar(200).)</p>
<h2 id="SetName-VALUE"><a href="#___top">SetName VALUE</a></h2>
<p>Set Name to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Name will be stored as a varchar(200).)</p>
<h2 id="Type"><a href="#___top">Type</a></h2>
<p>Returns the current value of Type. (In the database, Type is stored as varchar(200).)</p>
<h2 id="SetType-VALUE"><a href="#___top">SetType VALUE</a></h2>
<p>Set Type to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Type will be stored as a varchar(200).)</p>
<h2 id="RenderType1"><a href="#___top">RenderType</a></h2>
<p>Returns the current value of RenderType. (In the database, RenderType is stored as varchar(64).)</p>
<h2 id="SetRenderType-VALUE"><a href="#___top">SetRenderType VALUE</a></h2>
<p>Set RenderType to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, RenderType will be stored as a varchar(64).)</p>
<h2 id="MaxValues"><a href="#___top">MaxValues</a></h2>
<p>Returns the current value of MaxValues. (In the database, MaxValues is stored as int(11).)</p>
<h2 id="SetMaxValues-VALUE"><a href="#___top">SetMaxValues VALUE</a></h2>
<p>Set MaxValues to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, MaxValues will be stored as a int(11).)</p>
<h2 id="Pattern"><a href="#___top">Pattern</a></h2>
<p>Returns the current value of Pattern. (In the database, Pattern is stored as text.)</p>
<h2 id="SetPattern-VALUE"><a href="#___top">SetPattern VALUE</a></h2>
<p>Set Pattern to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Pattern will be stored as a text.)</p>
<h2 id="Repeated"><a href="#___top">Repeated</a></h2>
<p>Returns the current value of Repeated. (In the database, Repeated is stored as smallint(6).)</p>
<h2 id="SetRepeated-VALUE"><a href="#___top">SetRepeated VALUE</a></h2>
<p>Set Repeated to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Repeated will be stored as a smallint(6).)</p>
<h2 id="BasedOn"><a href="#___top">BasedOn</a></h2>
<p>Returns the current value of BasedOn. (In the database, BasedOn is stored as int(11).)</p>
<h2 id="SetBasedOn-VALUE"><a href="#___top">SetBasedOn VALUE</a></h2>
<p>Set BasedOn to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, BasedOn will be stored as a int(11).)</p>
<h2 id="Description"><a href="#___top">Description</a></h2>
<p>Returns the current value of Description. (In the database, Description is stored as varchar(255).)</p>
<h2 id="SetDescription-VALUE"><a href="#___top">SetDescription VALUE</a></h2>
<p>Set Description to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Description will be stored as a varchar(255).)</p>
<h2 id="SortOrder"><a href="#___top">SortOrder</a></h2>
<p>Returns the current value of SortOrder. (In the database, SortOrder is stored as int(11).)</p>
<h2 id="SetSortOrder-VALUE"><a href="#___top">SetSortOrder VALUE</a></h2>
<p>Set SortOrder to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, SortOrder will be stored as a int(11).)</p>
<h2 id="LookupType"><a href="#___top">LookupType</a></h2>
<p>Returns the current value of LookupType. (In the database, LookupType is stored as varchar(255).)</p>
<h2 id="SetLookupType-VALUE"><a href="#___top">SetLookupType VALUE</a></h2>
<p>Set LookupType to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, LookupType will be stored as a varchar(255).)</p>
<h2 id="Creator"><a href="#___top">Creator</a></h2>
<p>Returns the current value of Creator. (In the database, Creator is stored as int(11).)</p>
<h2 id="Created"><a href="#___top">Created</a></h2>
<p>Returns the current value of Created. (In the database, Created is stored as datetime.)</p>
<h2 id="LastUpdatedBy"><a href="#___top">LastUpdatedBy</a></h2>
<p>Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).)</p>
<h2 id="LastUpdated"><a href="#___top">LastUpdated</a></h2>
<p>Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.)</p>
<h2 id="Disabled"><a href="#___top">Disabled</a></h2>
<p>Returns the current value of Disabled. (In the database, Disabled is stored as smallint(6).)</p>
<h2 id="SetDisabled-VALUE"><a href="#___top">SetDisabled VALUE</a></h2>
<p>Set Disabled to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Disabled will be stored as a smallint(6).)</p>
<a href="./../">← Back to index</a>
|