C# Class SIL.FieldWorks.TE.TeImporter.ToolboxPictureInfo

Simple class to hold picture parameters as they're being read in, with a few convenient methods for interpreting the data from the SF field.
Show file Open project: sillsdev/FieldWorks

Public Properties

Property Type Description
Caption ITsIncStrBldr
Copyright string
Description string>.Dictionary
LayoutPos string
LocationRange string
LocationRangeType PictureLocationRangeType
PictureFilename string
ScaleFactor string

Public Methods

Method Description
AddDescriptionVariant ( string description, int ws ) : void

Adds the description variant.

HasDescriptionForWs ( int ws ) : bool

Determines whether we have a Description specified for the given writing system.

Method Details

AddDescriptionVariant() public method

Adds the description variant.
public AddDescriptionVariant ( string description, int ws ) : void
description string The description.
ws int The ID of the writing system.
return void

HasDescriptionForWs() public method

Determines whether we have a Description specified for the given writing system.
public HasDescriptionForWs ( int ws ) : bool
ws int The writing system ID.
return bool

Property Details

Caption public property

String builder for the picture caption.
public ITsIncStrBldr Caption
return ITsIncStrBldr

Copyright public property

Publishable information about the copyright that should appear on the copyright page of the publication.
public string Copyright
return string

Description public property

Illustration description. This is not published (at least in printed publications).
public Dictionary Description
return string>.Dictionary

LayoutPos public property

Indication of where in the column/page the picture is to be laid out.
public string LayoutPos
return string

LocationRange public property

The range of Scripture references or paragraphs in which this picture can be laid out.
public string LocationRange
return string

LocationRangeType public property

Indicates the type of data contained in LocationMin and LocationMax.
public PictureLocationRangeType LocationRangeType
return PictureLocationRangeType

PictureFilename public property

picture filename
public string PictureFilename
return string

ScaleFactor public property

Percentage by which picture is grown or shrunk.
public string ScaleFactor
return string