Difference between revisions of "Details Attributes"

From Lianjapedia
Jump to: navigation, search
Line 209: Line 209:
 
* See also [[Page Appearance]].
 
* See also [[Page Appearance]].
 
* For the [[:Category:Attributes#Gadgets|Gadget]], [[Field Attributes|Form Section Field]] and  [[Advanced Canvas Control Attributes|Canvas Section Advanced Control]] '''Height''' attribute, see [[Geometry]].
 
* For the [[:Category:Attributes#Gadgets|Gadget]], [[Field Attributes|Form Section Field]] and  [[Advanced Canvas Control Attributes|Canvas Section Advanced Control]] '''Height''' attribute, see [[Geometry]].
 +
 +
==Hide caption==
 +
Hide caption at runtime.
 +
 +
'''Supported by'''
 +
 +
[[:Category:Attributes#Gadgets|Gadgets]], [[Field Attributes|Form Section Fields]]
 +
 +
'''Notes'''
 +
 +
* For [[Advanced Canvas Control Attributes|Canvas Section Advanced Controls]] see [[#Show caption|Show caption]].
  
 
==Hide header==
 
==Hide header==
Line 347: Line 358:
  
 
'''Notes'''
 
'''Notes'''
 +
 +
==Show caption==
 +
Show the caption.
 +
 +
'''Supported by'''
 +
 +
[[Advanced Canvas Control Attributes|Canvas Section Advanced Controls]]
 +
 +
'''Notes'''
 +
 +
* For [[:Category:Attributes#Gadgets|Gadgets]] and [[Field Attributes|Form Section Fields]] see [[#Hide caption|Hide caption]].
  
 
==Show toolbar==
 
==Show toolbar==

Revision as of 06:16, 20 March 2020

Alias name

The alias name for this container or control.

Supported by

Page, Sections, Gadgets, Form Section Fields, Canvas Section Advanced Controls

Notes

App Doc

The App Doc file. This will be included in the App Doc when it is generated.

Supported by

App, Page, Sections, Gadgets, Form Section Fields, Canvas Section Advanced Controls

Notes

  • See App Doc for detailed information about App Doc generation.

Auto layout percent

Auto layout percentage of page size. If set to 0, then all sections on a page are resized to an equal height.

Supported by

Sections

Notes

Autosave in Page Library

Always save this page to the UI Page Library when an App is saved.

Supported by

Page

Notes

Caption

The section caption displayed in the section header.

Supported by

Sections

Notes

cVar = Lianja.getElementByID("page1.section1").caption

Command

A custom BROWSE or EDIT command to be executed in this section.

Supported by

Custom Section

Notes

  • For example:
BROWSE NOEDIT FIELDS name,account,amount=items*itemcount:h"Total

Custom Props

A ';' separated list of custom prop key pairs, e.g.

name=barry;company=lianja

Supported by

Page, Sections, Gadgets, Form Section Fields, Canvas Section Advanced Controls

Notes

  • You can get the value of Custom Props using Lianja.get("id").customprops.
  • The value can be decoded as an object using metadata_decode( Lianja.get("id").customprops ).
  • Custom Props are available in Desktop, Web and Mobile.
  • From v5.3.

Data source

The table and object column that this Image Strip is bound to, e.g. table.column.

Supported by

Image Strip Section

Notes

Database

The database for this section.

Supported by

Notes

Deferred load

When this is checked, this page (Page Attributes) or all pages in this App (App Settings) will be loaded with data only when first activated (speeds up App load time).

Supported by

App, Page

Notes

Desktop Margin Top

Adjust the top margin when laying out an inline gadget to line it up with others horizontally in desktop Apps. From v5.3.

Desktop Margin Top


Supported by

Gadgets

Notes

Double click to edit

Double click grid rows to edit data (True | False)

Supported by

Attachments Section, Grid Section

Notes

Double-click action

Page to activate on double click of a grid row

Supported by

Attachments Section, Grid Section

Notes

Filter

The filter expression that restricts the records that will be included in the data

Supported by

Notes

Fixed height

For Sections, the Fixed height attribute is a checkbox (True | False) determining whether the height should be fixed or not. The section height in pixels is set in the Height attribute.

For Gadgets, the Fixed height attribute defines the height of the gadget in pixels. If Fixed height is 0 (default), the gadget is autosized to the height of the containing section.

Supported by

Sections, Gadgets

Notes

Fixed width

Defines the width of the gadget in pixels. If Fixed width is 0 (default), the gadget is autosized to the available width of the containing section.

Supported by

Gadgets

Notes

Full name

The full name of the Section or Formitem including the parent page name and, for Formitems, the parent section name (readonly).

Supported by

Sections, Gadgets, Form Section Fields, Canvas Section Advanced Controls

Notes

Full page edit

Edit all editable sections on this page when the page is edited.

Supported by

Page

Notes

Gadget type

The type of gadget (readonly).

Supported by

Gadgets

Notes

Heading

The grid column heading.

Supported by

Grid Columns

Notes

Height

The section height in pixels.

Supported by

Sections

Notes

Hide caption

Hide caption at runtime.

Supported by

Gadgets, Form Section Fields

Notes

Hide header

Hide gadget header at runtime (True | False).

Supported by

Gadgets

Notes

Inline

Render the gadget inline rather than it its own column (True | False).

Supported by

Gadgets

Notes

Margin

Margin size in pixels around the gadget.

Supported by

Gadgets

Notes

Menu icon image

The menu icon image for the title (png | jpg | gif).

Supported by

Page

Notes

  • In the mobile client this icon will be displayed in the PageBar.

MetaData version

The MetaData version number. You can set this in the setupUI hook to prevent MetaData being applied multiple times.

Supported by

Sections

Notes

Meta types

A comma separated list of metatype names.

Supported by

Page, Sections, Gadgets, Form Section Fields, Canvas Section Advanced Controls, Grid Columns

Notes

Mobile login Page

When this is checked, this page will be used as the Mobile login page.

Supported by

Page

Notes

Name

The name for this container or control.

Supported by

Page, Sections, Gadgets, Form Section Fields, Canvas Section Advanced Controls

Notes

cVar = Lianja.getElementByID("page1").id
cVar = Lianja.getElementByID("page1.section1").id
cVar = Lianja.getElementByID("page1.section1.field1").id

OrderBy

Optionally specify an order for non-child sections. (From v4.1).

Supported by

Attachments Sections, Canvas Sections, Form Sections, Grid Sections.

Notes

  • It has no effect on child sections which require a specific record order based the parent->child relationship (Related Data 'Child key').
  • It is a dynamic attribute so it can be changed inside delegates.
  • Specifying an OrderBy will create an index on the specified column if it does not yet exist.
  • For web/mobile Apps, this must be the name of a single column in the section's bound table.
  • For desktop Apps, this can be the name of a single column in the section's bound table or the name of an existing index tag. Indexes can be created manually using the index on <key-expression> tag <tagname> command in the Lianja/VFP Command Window or Console Tab / Workspace.

Query Page

When this is checked, no data is shown until a search or filter has been performed.

Supported by

Page

Notes

Readonly

Section is readonly (True | False)

Supported by

Notes

Refresh when activated

Refresh all sections on this page when the page is activated.

Supported by

Page

Notes

Search field

The search field for the section

Supported by

Notes

Section to refresh when data modified

Section to refresh when data is modified in this section

Supported by

Canvas Section, Form Section, Grid Section

Notes

Show caption

Show the caption.

Supported by

Canvas Section Advanced Controls

Notes

Show toolbar

Enable or disable editor toolbar (True | False).

Supported by

Editbox Gadget and Richtexteditor Gadget

Notes

Snap objects to grid

When adding objects to the canvas, snap to grid when drop (True | False)

Supported by

Canvas Section

Notes

Snap objects to grid size

Number of pixels to snap to grid when drop

Supported by

Canvas Section

Notes

SQL statement

The SQL statement used to populate a Virtual Table. Use {} macros in the WHERE condition to relate parent-->child sections and ORDER BY to order the display of records. This is native SQL for the target SQL database and may call stored procedures as well as SQL Select.

Supported by

Notes

Stretch width

Auto stretch the width of the gadget into the width of the section (True | False)

Supported by

Gadgets

Notes

Sortable

Section is sortable by clicking on the column headers (True | False)

Supported by

Attachments Section, Grid Section

Notes

Table

The table for this section.

Supported by

Notes

Tag

The tag for this formitem.

Supported by

Gadgets, Form Section Fields, Canvas Section Advanced Controls

Notes

  • Giving multiple controls the same Tag facilitates handling them as a group.

Timelines enabled

Enable database timelines for this section.

Supported by

Notes

Title

The menu title for this page.

Supported by

Page

Notes

Type

The type of container or control (readonly).

Supported by

Sections, Gadgets, Form Section Fields, Canvas Section Advanced Controls

Notes

cVar = Lianja.getElementByID("page1.section1").type
cVar = Lianja.getElementByID("page1.section1.field1").type

Web Margin Top

Adjust the top margin when laying out an inline gadget to line it up with others horizontally in Web/Mobile Apps. From v5.3.

Supported by

Gadgets

Notes

Where condition

The dynamic WHERE condition for a Virtual Table that restricts which records will be retrieved

Supported by

Notes