Jeremie Leroy - XOJO Controls Wiki - User contributions [en]

RibbonCanvas

2017-06-12T16:49:16Z

Admin: /* History */

The RibbonCanvas is a custom Canvas that displays a Ribbon similar to Microsoft Office and Windows 7 Paint and WordPad.

{| class=eventTable
|-
|class=titleClass colspan=2|Events
|-
|width=50%|{{Event | name=Action | params=SectionName As String, ButtonName As String | description= | newinversion=}}
|width=50%|{{Event | name=Minimized | description= | newinversion=}}
|-
|width=50%|{{Event | name=Change | description= | newinversion=}}
|width=50%|{{Event | name=MouseDown | params=X As Integer, Y As Integer | description= | returntype=Boolean | newinversion=}}
|-
|width=50%|{{Event | name=GearIconClicked | description= | returntype=Boolean | newinversion=1.2.0}}
|width=50%|{{Event | name=Open | description= | newinversion=}}
|-
|width=50%|{{Event | name=GetIcon | params=IconName As String | description= | returntype=Picture | newinversion=}}
|width=50%|{{Event | name=OpenRecent | params=f As FolderItem | description= | newinversion=}}
|-
|width=50%|{{Event | name=GetMenu | params=SectionName As String, ButtonName As String | description= | returntype=MenuItem | newinversion=}}
|width=50%|{{Event | name=Restored | description= | newinversion=}}
|-
|width=50%|{{Event | name=HeightChange | description= | newinversion=}}

|-
|width=50%|{{Event | name=MenuAction | params=SectionName As String, ButtonName As String, hitItem As MenuItem | description= | newinversion=}}

|-
|}

{| class=propertyTable
|-
|class=titleClass colspan=3|Properties
|-
|width=33%|{{Property | name=Animate | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=Hidden | type=Boolean | description= | readonly=yes | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=ShowTooltips | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
|-
|width=33%|{{Property | name=AutoHide | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=HideButtonLeft | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=Style | type=Integer | description= | readonly=yes | newinversion= | version=1.2.5}}
|-
|width=33%|{{Property | name=BackColor | type=Color | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=LastError | type=String | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=TabCount | type=Integer | description= | readonly=yes | newinversion= | version=1.2.5}}
|-
|width=33%|{{Property | name=BestHeight | type=Integer | description= | readonly=yes | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=LeftOffset | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=TabInnerOffset | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
|-
|width=33%|{{Property | name=BorderColor | type=Color | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=Main | type=RibbonMain | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=TabMidOffset | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
|-
|width=33%|{{Property | name=EmbeddedControls | type=RibbonEmbeddedControl | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=ShowGearIcon | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=Tabs | type=RibbonTab | description= | readonly=no | newinversion= | version=1.2.5}}
|-
|width=33%|{{Property | name=Freeze | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=ShowHideButton | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=Value | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
|-
|width=33%|{{Property | name=FullRefresh | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=ShowRefreshTime | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}

|-
|width=33%|{{Property | name=GearIcon | type=Picture | description= | readonly=no | newinversion= | version=1.2.5}}
|width=33%|{{Property | name=ShowTabs | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}

|-
|width=33%|{{Property | name=Hidden | type=Boolean | description= | readonly=yes | newinversion= | version=1.2.5}}
|}

{| class=methodTable
|-
|class=titleClass colspan=3|Methods
|-
|width=33%|{{Method | name=AddOpenRecent | params=f As FolderItem | description= | newinversion=}}
|width=33%|{{Method | name=Redisplay | description= | newinversion=}}
|width=33%|{{Method | name=Show | params=Refresh As Boolean = True | description= | newinversion=}}
|-
|width=33%|{{Method | name=EmbedControl | params=c As RectControl, Left As Integer = - 1, Top As Integer = - 1, Tab As Integer = - 1, Section As Integer = - 1, Button As Integer = - 1 | description= | newinversion=}}
|width=33%|{{Method | name=RemoveOpenRecent | params=f As FolderItem | description= | newinversion=}}
|width=33%|{{Method | name=toRB | params=FullConstructor As Boolean = False, SaveStyle As Boolean = True | description= | returntype=String | newinversion=}}
|-
|width=33%|{{Method | name=GetButton | params=ButtonName As String | description= | returntype=RibbonButton | newinversion=}}
|width=33%|{{Method | name=SendAcceleratorKey | params=Key As String | description= | returntype=Boolean | newinversion=}}
|width=33%|{{Method | name=toXML | params=SaveValue As Boolean = True, SaveStyle As Boolean = True, SaveAllOptions As Boolean = False, SavePictureInXML As Boolean = False | description= | returntype=String | newinversion=}}
|-
|width=33%|{{Method | name=GetMainOption | params=Name As String | description= | returntype=RibbonMainOption | newinversion=}}
|width=33%|{{Method | name=SetColor | params=C As Color | description= | newinversion=}}

|-
|width=33%|{{Method | name=Hide | params=Refresh As Boolean = True | description= | newinversion=}}
|width=33%|{{Method | name=SetHighlightColor | params=C As Color | description= | newinversion=}}

|-
|width=33%|{{Method | name=LoadFromXML | params=XMLString As String | description= | returntype=Boolean | newinversion=}}
|width=33%|{{Method | name=SetStyle | params=value As Integer | description= | newinversion=}}

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Shared Methods
|-
|{{Method | name=Register | params=Name As String, ProductKey As String, SerialKey As Integer | description= | returntype=Boolean | newinversion=}}
|-

|-
|}

==History==

===Version 1.6.0 - Released 2016-11-14 ===
*New:
**Updated for Xojo 2017R1

*Fix
**OutOfBoundsException on Windows

===Version 1.5.0 - Released 2015-11-28 ===

*Fix
**Several bug fixes

===Version 1.4.0 - Released 2014-09-01 ===
*New:
**Office2013 Style
**Colored Tabs
**Compatible with Xojo

*Deprecated:
**Office2007 Style is no longer supported. No updates or bug fixes will be added for this style.

===Version 1.3.0 - Released 2013-04-27 ===
*New:
**Office2013 Style
**Colored Tabs

*Deprecated:
**Office2007 Style is no longer supported. No updates or bug fixes will be added for this style.

===Version 1.2.5 - Released 2012-05-25===
*Fix:
**Crash on Mac OS with StyleOffice2011 (gradient2)
**Crash on Mac OS (RibbonHelpWindow)
**Embedded control not displaying properly if the Ribbon isn't in top left position.

===Version 1.2.4 - Released 2012-04-15===
*New:
**Removed Class TooltipTimer which isn't needed anymore

*Fix:
**embeddedControl
**Graphical bug in StyleOffice2010
**Buttons with menu: PopupArrow missing the tip pixel in newer versions of RealStudio

===Version 1.2.1===
**Contextual Click in RibbonHelpWindow does not trigger [[RibbonCanvas.Action|Action]] anymore

==See Also==

[[RibbonButton]], [[RibbonSection]], [[RibbonTab]], [[RibbonMenu]], [[RibbonMenuOption]] classes.

Jly Icons8

2017-06-04T16:26:25Z

Admin:

A very handy class that gives access to 50,000+ icons from Icons8

The perfect tool for prototyping a design without having to include tens or hundreds of icons in your App, in both standard and HiDPI.

jly_Icons8 automatically handles the ScaleFactor for you.

Compatible with '''Desktop, Console''' and '''iOS''' applications.

{| class=propertyTable
|-
|class=titleClass colspan=1|Properties
|-
|{{Property | name=Completed | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconColor | type=Color | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconSize | type=Integer | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconStyle | type=jly_Icons8.Styles | description= | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=propertyTable
|-
|class=titleClass colspan=1|Shared Properties
|-
|{{Property | name=globalScaleFactor | type=Double | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=globalStyle | type=Styles | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=UseCache | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Methods
|-
|{{Method | name=Constructor | params=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0 | description= | newinversion=}}
|-
|{{Method | name=Destructor | description= | newinversion=}}
|-
|{{Method | name=FindImageInCache | params=Name As Text, CheckExpiry As Boolean = True | description= | returntype=Auto | newinversion=}}
|-
|{{Method | name=IconURL | params=Name As Text | description= | returntype=Text | newinversion=}}
|-
|{{Method | name=LoadIcon | params=Name As Text, callback As Auto, moreData As Xojo.Core.Dictionary = nil, IgnoreCache As Boolean = False | description= | newinversion=}}
|-
|{{Method | name=PreloadIcon | params=Name As Text, size As Integer = -1, IgnoreCache As Boolean = False | description= | newinversion=}}
|-

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Shared Methods
|-
|{{Method | name=LoadIconSimple | params=Name As Text, Size As Integer, control As Auto, aColor as Color = &c0 | description= | returntype=jly_Icons8 | newinversion=}}
|-

|-
|}

==Enumerations==

'''Styles'''

The following styles are available from Icons8

*ios
*win
*win8
*material
*android4
*color
*office
*ultraviolet
*dotty
*nolan
*dusk
==More Info==

===Icons8===
https://icons8.com

===Icons8 License===
https://icons8.com/license/

Jly Icons8.Constructor

2017-06-04T15:32:50Z

Admin:

{{MethodBox
| name=Constructor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0
| returntype=
| version=1
| platform=all
}}

The constructor for the class.

The default ''style'' is iOS (line icons). Only the ''Size'' is a required parameter.

The size should be the display size whatever the resolution.

If you need a 32x32px icon for HiDPI Display, set the globalScaleFactor and set IconSize to 32 in this function.

Jly Icons8

2017-06-04T15:30:25Z

Admin: /* More Info */

A very handy class that gives access to 50,000+ icons from Icons8

The perfect tool for prototyping a design without having to include tens or hundreds of icons in your App, in both standard and HiDPI.

jly_Icons8 automatically handles the ScaleFactor for you.

Compatible with '''Desktop, Web, Console''' and '''iOS''' applications.

{| class=propertyTable
|-
|class=titleClass colspan=1|Properties
|-
|{{Property | name=Completed | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconColor | type=Color | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconSize | type=Integer | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconStyle | type=jly_Icons8.Styles | description= | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=propertyTable
|-
|class=titleClass colspan=1|Shared Properties
|-
|{{Property | name=globalScaleFactor | type=Double | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=globalStyle | type=Styles | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=UseCache | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Methods
|-
|{{Method | name=Constructor | params=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0 | description= | newinversion=}}
|-
|{{Method | name=Destructor | description= | newinversion=}}
|-
|{{Method | name=FindImageInCache | params=Name As Text, CheckExpiry As Boolean = True | description= | returntype=Auto | newinversion=}}
|-
|{{Method | name=IconURL | params=Name As Text | description= | returntype=Text | newinversion=}}
|-
|{{Method | name=LoadIcon | params=Name As Text, callback As Auto, moreData As Xojo.Core.Dictionary = nil, IgnoreCache As Boolean = False | description= | newinversion=}}
|-
|{{Method | name=PreloadIcon | params=Name As Text, size As Integer = -1, IgnoreCache As Boolean = False | description= | newinversion=}}
|-

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Shared Methods
|-
|{{Method | name=LoadIconSimple | params=Name As Text, Size As Integer, control As Auto, aColor as Color = &c0 | description= | returntype=jly_Icons8 | newinversion=}}
|-

|-
|}

==Enumerations==

'''Styles'''

The following styles are available from Icons8

*ios
*win
*win8
*material
*android4
*color
*office
*ultraviolet
*dotty
*nolan
*dusk
==More Info==

===Icons8===
https://icons8.com

===Icons8 License===
https://icons8.com/license/

Jly Icons8.globalStyle

2017-06-04T15:29:42Z

Admin: 1 revision imported

{{PropertyBox
| name=globalStyle
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Styles
| readonly=no
}}

The style to use with [[jly_Icons8.LoadIconSimple|LoadIconSimple]] method.

Jly Icons8.Completed

2017-06-04T15:29:42Z

Admin: 1 revision imported

{{PropertyBox
| name=Completed
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Boolean
| readonly=no
}}

This property will be True when icon loading is completed.

Jly Icons8.globalScaleFactor

2017-06-04T15:29:42Z

Admin: 1 revision imported

{{PropertyBox
| name=globalScaleFactor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Double
| readonly=no
}}

This property isn't accessible on iOS because it is handled automatically.

On desktop apps, set this property to self.ScaleFactor in the main Window.Open event.

Jly Icons8.UseCache

2017-06-04T15:29:42Z

Admin: 1 revision imported

{{PropertyBox
| name=UseCache
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Boolean
| readonly=no
}}

If True, the Icons8 class will cache all icons in
xojo.IO.SpecialFolder.Caches.Child("icons8") folder.

This enables displaying the icons without network access as long as they were loaded once.

Jly Icons8.IconSize

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{PropertyBox
| name=IconSize
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Integer
| readonly=no
}}

The size of the icon that will be loaded with this instance of jly_Icons8.

If you need an 32x32px icon @2x (for HiDPI) set this property to 32 and [[jly_Icons8.globalScaleFactor|globalScaleFactor]] to 2.0

Jly Icons8

2017-06-04T15:29:41Z

Admin: 1 revision imported

A very handy class that gives access to 50,000+ icons from Icons8

The perfect tool for prototyping a design without having to include tens or hundreds of icons in your App, in both standard and HiDPI.

jly_Icons8 automatically handles the ScaleFactor for you.

Compatible with '''Desktop, Web, Console''' and '''iOS''' applications.

{| class=propertyTable
|-
|class=titleClass colspan=1|Properties
|-
|{{Property | name=Completed | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconColor | type=Color | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconSize | type=Integer | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconStyle | type=jly_Icons8.Styles | description= | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=propertyTable
|-
|class=titleClass colspan=1|Shared Properties
|-
|{{Property | name=globalScaleFactor | type=Double | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=globalStyle | type=Styles | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=UseCache | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Methods
|-
|{{Method | name=Constructor | params=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0 | description= | newinversion=}}
|-
|{{Method | name=Destructor | description= | newinversion=}}
|-
|{{Method | name=FindImageInCache | params=Name As Text, CheckExpiry As Boolean = True | description= | returntype=Auto | newinversion=}}
|-
|{{Method | name=IconURL | params=Name As Text | description= | returntype=Text | newinversion=}}
|-
|{{Method | name=LoadIcon | params=Name As Text, callback As Auto, moreData As Xojo.Core.Dictionary = nil, IgnoreCache As Boolean = False | description= | newinversion=}}
|-
|{{Method | name=PreloadIcon | params=Name As Text, size As Integer = -1, IgnoreCache As Boolean = False | description= | newinversion=}}
|-

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Shared Methods
|-
|{{Method | name=LoadIconSimple | params=Name As Text, Size As Integer, control As Auto, aColor as Color = &c0 | description= | returntype=jly_Icons8 | newinversion=}}
|-

|-
|}

==Enumerations==

'''Styles'''

The following styles are available from Icons8

*ios
*win
*win8
*material
*android4
*color
*office
*ultraviolet
*dotty
*nolan
*dusk
==More Info==

Icons8
https://icons8.com

Icons8 License
https://icons8.com/license/

Jly Icons8.LoadIcon

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{MethodBox
| name=LoadIcon
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=Name As Text, callback As Auto, moreData As Xojo.Core.Dictionary = nil, IgnoreCache As Boolean = False
| returntype=
| version=1
| platform=all
}}

Searches the icon in cache and loads it from the icons8 CDN if it wasn't found.
The Icon is sent back to the'' callback'' delegate.
Use'' moreData'' dictionary to set additional parameters if needed.

Jly Icons8.Constructor

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{MethodBox
| name=Constructor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0
| returntype=
| version=1
| platform=all
}}

The [[jly_Icons8.Constructor|Constructor]] for the class.
The default ''style'' is iOS (line icons). Only the'' Size'' is a required parameter.

Jly Icons8.Destructor

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{MethodBox
| name=Destructor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=
| returntype=
| version=1
| platform=all
}}

The [[jly_Icons8.Destructor|Destructor]] for the class.

Jly Icons8.LoadIconSimple

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{MethodBox
| name=LoadIconSimple
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=Name As Text, Size As Integer, control As Auto, aColor as Color = &c0
| returntype=jly_Icons8
| version=1
| platform=all
}}

The simplest way to set an image using Icons8.

==Control compatibility==

*iOS*
*iOSImageView
*iOSToolButton
*iOSTableCellData

Jly Icons8.IconURL

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{MethodBox
| name=IconURL
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=Name As Text
| returntype=Text
| version=1
| platform=all
}}

Returns the URL to the icon with the given parameters

Jly Icons8.FindImageInCache

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{MethodBox
| name=FindImageInCache
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=Name As Text, CheckExpiry As Boolean = True
| returntype=Auto
| version=1
| platform=all
}}

Searches the cache to find an image by its URL.
If'' CheckExpiry'' is False, the cache expiration set by the server will be overridden.

Jly Icons8.PreloadIcon

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{MethodBox
| name=PreloadIcon
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=Name As Text, size As Integer = -1, IgnoreCache As Boolean = False
| returntype=
| version=1
| platform=all
}}

Preloads an icon based on IconSize, [[jly_Icons8.IconColor|IconColor]] and IconStyle.
If Force is true, the image will be loaded from the Internet whatever the cache expiration date.

Jly Icons8.IconStyle

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{PropertyBox
| name=IconStyle
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=jly_Icons8.Styles
| readonly=no
}}

The style of the icon that will be loaded with this instance of jly_Icons8.

Use the Styles enumeration to see the list of available styles.

Jly Icons8.IconColor

2017-06-04T15:29:41Z

Admin: 1 revision imported

{{PropertyBox
| name=IconColor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Color
| readonly=no
}}

The color of the icon that will be loaded with this instance of jly_Icons8.

Jly Icons8

2017-06-04T15:05:00Z

Admin: 1 revision imported

A very handy class that gives access to 50,000+ icons from Icons8

The perfect tool for prototyping a design without having to include tens or hundreds of icons in your App, in both standard and HiDPI.

jly_Icons8 automatically handles the ScaleFactor for you.

{| class=propertyTable
|-
|class=titleClass colspan=1|Properties
|-
|{{Property | name=callback | type=LoadIconDelegate | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=callbackiOS | type=LoadIconDelegateiOS | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=Completed | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconColor | type=Color | description=The color of the icon that will be loaded with this instance of jly_Icons8. | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconSize | type=Integer | description=The size of the icon that will be loaded with this instance of jly_Icons8. | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=IconStyle | type=jly_Icons8.Styles | description=The style of the icon that will be loaded with this instance of jly_Icons8. | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=propertyTable
|-
|class=titleClass colspan=1|Shared Properties
|-
|{{Property | name=globalScaleFactor | type=Double | description=This property isn't accessible on iOS because it is handled automatically. | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=globalStyle | type=Styles | description=The style to use with [[jly_Icons8.LoadIconSimple|LoadIconSimple]] method. | readonly=no | newinversion= | version=1}}
|-
|{{Property | name=UseCache | type=Boolean | description=If True, the Icons8 class will cache all icons in | readonly=no | newinversion= | version=1}}
|-

|-
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Methods
|-
|{{Method | name=Constructor | params=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0 | description=The [[jly_Icons8.Constructor|Constructor]] for the class. | newinversion=}}
|-
|{{Method | name=Destructor | description=The [[jly_Icons8.Destructor|Destructor]] for the class. | newinversion=}}
|-
|{{Method | name=FindImageInCache | params=Name As Text, CheckExpiry As Boolean = True | description=Searches the cache to find an image by its URL. | returntype=Auto | newinversion=}}
|-
|{{Method | name=IconURL | params=Name As Text | description=Returns the URL to the icon with the given parameters | returntype=Text | newinversion=}}
|-
|{{Method | name=LoadIcon | params=Name As Text, callback As Auto, moreData As Xojo.Core.Dictionary = nil, IgnoreCache As Boolean = False | description=Searches the icon in cache and loads it from the icons8 CDN if it wasn't found. | newinversion=}}
|-
|{{Method | name=LoadIconSimple | params=Name As Text, Size As Integer, control As Auto, aColor as Color = &c0 | description=The simplest way to set an image using Icons8. | returntype=jly_Icons8 | newinversion=}}
|-
|{{Method | name=PreloadIcon | params=Name As Text, size As Integer = -1, IgnoreCache As Boolean = False | description=Preloads an icon based on IconSize, [[jly_Icons8.IconColor|IconColor]] and IconStyle. | newinversion=}}
|-

|-
|}

==Enumerations==

==Styles==

The following styles are available from Icons8

*ios
*win
*win8
*material
*android4
*color
*office
*ultraviolet
*dotty
*nolan
*dusk

Jly Icons8.LoadIcon

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.Constructor

2017-06-04T15:05:00Z

Admin: 1 revision imported

{{MethodBox
| name=Constructor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| parameters=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0
| returntype=
| version=1
| platform=all
}}

The [[jly_Icons8.Constructor|Constructor]] for the class.
The default ''style'' is iOS (line icons). Only the'' Size'' is a required parameter.

Jly Icons8.Destructor

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.LoadIconSimple

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.IconURL

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.FindImageInCache

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.PreloadIcon

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.IconStyle

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.IconColor

2017-06-04T15:05:00Z

Admin: 1 revision imported

{{PropertyBox
| name=IconColor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Color
| readonly=no
}}

The color of the icon that will be loaded with this instance of jly_Icons8.

Jly Icons8.IconSize

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.callbackiOS

2017-06-04T15:05:00Z

Admin: 1 revision imported

{{PropertyBox
| name=callbackiOS
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=LoadIconDelegateiOS
| readonly=no
}}

Jly Icons8.globalStyle

2017-06-04T15:05:00Z

Admin: 1 revision imported

{{PropertyBox
| name=globalStyle
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Styles
| readonly=no
}}

The style to use with [[jly_Icons8.LoadIconSimple|LoadIconSimple]] method.

Jly Icons8.callback

2017-06-04T15:05:00Z

Admin: 1 revision imported

{{PropertyBox
| name=callback
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=LoadIconDelegate
| readonly=no
}}

Jly Icons8.Completed

2017-06-04T15:05:00Z

Admin: 1 revision imported

{{PropertyBox
| name=Completed
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Boolean
| readonly=no
}}

Jly Icons8.globalScaleFactor

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8.UseCache

2017-06-04T15:05:00Z

Admin: 1 revision imported

Jly Icons8

2017-06-04T14:51:14Z

Admin:

A very handy class that gives access to 50,000+ icons from Icons8

The perfect tool for prototyping a design without having to include tens or hundreds of icons in your App, in both standard and HiDPI.

jly_Icons8 automatically handles the ScaleFactor for you.

[[File:https://png.icons8.com/iphone/ultraviolet]]

{| class=propertyTable
|-
|class=titleClass colspan=2|Properties
|-
|width=50%|{{Property | name=callback | type=LoadIconDelegate | description= | readonly=no | newinversion= | version=1}}
|width=50%|{{Property | name=IconColor | type=Color | description= | readonly=no | newinversion= | version=1}}
|-
|width=50%|{{Property | name=callbackiOS | type=LoadIconDelegateiOS | description= | readonly=no | newinversion= | version=1}}
|width=50%|{{Property | name=IconSize | type=Integer | description= | readonly=no | newinversion= | version=1}}
|-
|width=50%|{{Property | name=Completed | type=Boolean | description= | readonly=no | newinversion= | version=1}}
|width=50%|{{Property | name=IconStyle | type=jly_Icons8.Styles | description= | readonly=no | newinversion= | version=1}}
|-
|width=50%|{{Property | name=globalScaleFactor | type=Double | description=This property isn't accessible on iOS because it is handled automatically. | readonly=no | newinversion= | version=1}}
|width=50%|{{Property | name=UseCache | type=Boolean | description=If True, the Icons8 class will cache all icons in | readonly=no | newinversion= | version=1}}
|-
|width=50%|{{Property | name=globalStyle | type=Styles | description=The style to use with [[jly_Icons8.LoadIconSimple|LoadIconSimple]] method. | readonly=no | newinversion= | version=1}}

|-
|width=50%|{{Property | name=IconColor | type=Color | description= | readonly=no | newinversion= | version=1}}
|}

{| class=methodTable
|-
|class=titleClass colspan=1|Methods
|-
|{{Method | name=Constructor | params=style As Styles = Styles.ios, Size As Integer, aColor As Color= &c0 | description=The [[jly_Icons8.Constructor|Constructor]] for the class. | newinversion=}}
|-
|{{Method | name=Destructor | description=The [[jly_Icons8.Destructor|Destructor]] for the class. | newinversion=}}
|-
|{{Method | name=FindImageInCache | params=Name As Text, CheckExpiry As Boolean = True | description=Searches the cache to find an image by its URL. | returntype=Auto | newinversion=}}
|-
|{{Method | name=IconURL | params=Name As Text | description=Returns the URL to the icon with the given parameters | returntype=Text | newinversion=}}
|-
|{{Method | name=LoadIcon | params=Name As Text, callback As Auto, moreData As Xojo.Core.Dictionary = nil, IgnoreCache As Boolean = False | description=Searches the icon in cache and loads it from the icons8 CDN if it wasn't found. | newinversion=}}
|-
|{{Method | name=LoadIconSimple | params=Name As Text, Size As Integer, control As Auto, aColor as Color = &c0 | description=The simplest way to set an image using Icons8. | returntype=jly_Icons8 | newinversion=}}
|-
|{{Method | name=PreloadIcon | params=Name As Text, size As Integer = -1, IgnoreCache As Boolean = False | description=Preloads an icon based on IconSize, [[jly_Icons8.IconColor|IconColor]] and IconStyle. | newinversion=}}
|-

|-
|}

==Enumerations==

==Styles==

The following styles are available from Icons8

*ios
*win
*win8
*material
*android4
*color
*office
*ultraviolet
*dotty
*nolan
*dusk

Jly Icons8.Destructor

2017-06-04T14:39:33Z

Admin: 1 revision imported

Jly Icons8.LoadIconSimple

2017-06-04T14:39:33Z

Admin: 1 revision imported

Jly Icons8.IconURL

2017-06-04T14:39:33Z

Admin: 1 revision imported

Jly Icons8.FindImageInCache

2017-06-04T14:39:33Z

Admin: 1 revision imported

Jly Icons8.PreloadIcon

2017-06-04T14:39:33Z

Admin: 1 revision imported

Jly Icons8.IconStyle

2017-06-04T14:39:33Z

Admin: 1 revision imported

{{PropertyBox
| name=IconStyle
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=jly_Icons8.Styles
| readonly=no
}}

Jly Icons8.IconColor

2017-06-04T14:39:33Z

Admin: 1 revision imported

{{PropertyBox
| name=IconColor
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Color
| readonly=no
}}

Jly Icons8.IconSize

2017-06-04T14:39:33Z

Admin: 1 revision imported

{{PropertyBox
| name=IconSize
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Integer
| readonly=no
}}

Jly Icons8.callbackiOS

2017-06-04T14:39:33Z

Admin: 1 revision imported

{{PropertyBox
| name=callbackiOS
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=LoadIconDelegateiOS
| readonly=no
}}

Jly Icons8.globalStyle

2017-06-04T14:39:33Z

Admin: 1 revision imported

{{PropertyBox
| name=globalStyle
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Styles
| readonly=no
}}

The style to use with [[jly_Icons8.LoadIconSimple|LoadIconSimple]] method.

Jly Icons8.callback

2017-06-04T14:39:33Z

Admin: 1 revision imported

{{PropertyBox
| name=callback
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=LoadIconDelegate
| readonly=no
}}

Jly Icons8.Completed

2017-06-04T14:39:33Z

Admin: 1 revision imported

{{PropertyBox
| name=Completed
| owner=[[jly_Icons8]]
| ownertype=class
| scope=public
| type=Boolean
| readonly=no
}}

Jly Icons8.globalScaleFactor

2017-06-04T14:39:33Z

Admin: 1 revision imported