SCCustomPropertyDefinition

@interface SCCustomPropertyDefinition : SCPropertyDefinition

This class functions as a property definition for SCDataDefinition that will generate a custom user inteface element (e.g.: custom cell).

‘SCCustomPropertyDefinition’ does not have to represent a property that actually exists in its class (unlike an SCPropertyDefiniton), and is often used in a structure definition as a placeholder for custom user interface element generation.

See

SCPropertyDefinition.

Creation and Initialization

  • Allocates and returns an initialized ‘SCCustomPropertyDefinition’ given a property name and a class of the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementClass The class of the custom user interface element that will be generated.
    • - parameter: bindings This dictionary specifies how each of the uiElement’s custom controls binds itself to the data definition’s properties. Each dictionary key should be the tag string value of one of the uiElement’s custom controls, and the value should be the name of the class definition’s property that is bound to that control.
    • - warning: IMPORTANT: All control tags must be greater than zero.

    Declaration

    Objective-C

    + (instancetype)definitionWithName:(NSString *)propertyName
                        uiElementClass:(Class)elementClass
                        objectBindings:(NSDictionary *)bindings;
  • Allocates and returns an initialized ‘SCCustomPropertyDefinition’ given a property name and a class of the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementClass The class of the custom user interface element that will be generated.
    • Example bindings string: NSString *bindingsString = @“1:firstName;2:lastName”;

    • Warning

      IMPORTANT: All control tags must be greater than zero.

    Declaration

    Objective-C

    + (instancetype)definitionWithName:(NSString *)propertyName
                        uiElementClass:(Class)elementClass
                  objectBindingsString:(NSString *)bindingsString;

    Parameters

    bindingsString

    This string specifies how each of the uiElement’s custom controls binds itself to the data definition’s properties. The string should consist of a colon separated pair of control’s tag and the property name, while each pair should be separated by a semi-colon.

  • Allocates and returns an initialized ‘SCCustomPropertyDefinition’ given a property name and the name of the nib file containing the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementNibName The name of the nib file containing the custom user interface element that will be generated.
    • - parameter: bindings This dictionary specifies how each of the uiElement’s custom controls binds itself to the data definition’s properties. Each dictionary key should be the tag string value of one of the uiElement’s custom controls, and the value should be the name of the class definition’s property that is bound to that control.
    • - warning: IMPORTANT: All control tags must be greater than zero.
    • - note: If the NIB is a SwiftPM resource then the name should use a PACKAGE_TARGET_Name format.

    Declaration

    Objective-C

    + (instancetype)definitionWithName:(NSString *)propertyName
                      uiElementNibName:(NSString *)elementNibName
                        objectBindings:(NSDictionary *)bindings;
  • Allocates and returns an initialized ‘SCCustomPropertyDefinition’ given a property name and the name of the nib file containing the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementNibName The name of the nib file containing the custom user interface element that will be generated.
    • Example bindings string: NSString *bindingsString = @“1:firstName;2:lastName”;

    • Warning

      IMPORTANT: All control tags must be greater than zero.
    • Note

      If the NIB is a SwiftPM resource then the name should use a PACKAGE_TARGET_Name format.

    Declaration

    Objective-C

    + (instancetype)definitionWithName:(NSString *)propertyName
                      uiElementNibName:(NSString *)elementNibName
                  objectBindingsString:(NSString *)bindingsString;

    Parameters

    bindingsString

    This string specifies how each of the uiElement’s custom controls binds itself to the data definition’s properties. The string should consist of a colon separated pair of control’s tag and the property name, while each pair should be separated by a semi-colon.

  • Returns an initialized ‘SCCustomPropertyDefinition’ given a property name and a class of the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementClass The class of the custom user interface element that will be generated.
    • - parameter: bindings This dictionary specifies how each of the uiElement’s custom controls binds itself to the data definition’s properties. Each dictionary key should be the tag string value of one of the uiElement’s custom controls, and the value should be the name of the class definition’s property that is bound to that control.
    • - warning: IMPORTANT: All control tags must be greater than zero.

    Declaration

    Objective-C

    - (instancetype)initWithName:(NSString *)propertyName
                  uiElementClass:(Class)elementClass
                  objectBindings:(NSDictionary *)bindings;
  • Returns an initialized ‘SCCustomPropertyDefinition’ given a property name and a class of the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementClass The class of the custom user interface element that will be generated.
    • Example bindings string: NSString *bindingsString = @“1:firstName;2:lastName”;

    • Warning

      IMPORTANT: All control tags must be greater than zero.

    Declaration

    Objective-C

    - (instancetype)initWithName:(NSString *)propertyName
                  uiElementClass:(Class)elementClass
            objectBindingsString:(NSString *)bindingsString;

    Parameters

    bindingsString

    This string specifies how each of the uiElement’s custom controls binds itself to the data definition’s properties. The string should consist of a colon separated pair of control’s tag and the property name, while each pair should be separated by a semi-colon.

  • Returns an initialized ‘SCCustomPropertyDefinition’ given a property name and the name of the nib file containing the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementNibName The name of the nib file containing the custom user interface element that will be generated.
    • - parameter: bindings This dictionary specifies how each of the uiElement’s custom controls binds itself to the class definition’s properties. Each dictionary key should be the tag string value of one of the uiElement’s custom controls, and the value should be the name of the class definition’s property that is bound to that control.
    • - warning: IMPORTANT: All control tags must be greater than zero.
    • - note: If the NIB is a SwiftPM resource then the name should use a PACKAGE_TARGET_Name format.

    Declaration

    Objective-C

    - (instancetype)initWithName:(NSString *)propertyName
                uiElementNibName:(NSString *)elementNibName
                  objectBindings:(NSDictionary *)bindings;
  • Allocates and returns an initialized ‘SCCustomPropertyDefinition’ given a property name and a class of the custom user interface element to generate. *

    • - parameter: propertyName The name of the property.
    • - parameter: elementNibName The name of the nib file containing the custom user interface element that will be generated.
    • Example bindings string: NSString *bindingsString = @“1:firstName;2:lastName”;

    • Warning

      IMPORTANT: All control tags must be greater than zero.
    • Note

      If the NIB is a SwiftPM resource then the name should use a PACKAGE_TARGET_Name format.

    Declaration

    Objective-C

    - (instancetype)initWithName:(NSString *)propertyName
                uiElementNibName:(NSString *)elementNibName
            objectBindingsString:(NSString *)bindingsString;

    Parameters

    bindingsString

    This string specifies how each of the uiElement’s custom controls binds itself to the data definition’s properties. The string should consist of a colon separated pair of control’s tag and the property name, while each pair should be separated by a semi-colon.