C# Class SIL.FieldWorks.FDO.DomainImpl.CmPictureFactory

Mostrar archivo Open project: sillsdev/FieldWorks

Public Methods

Method Description
Create ( string srcFilename, ITsString captionTss, string sFolder ) : ICmPicture

Construct a CmPicture for the given file, having the given caption, and located in the given folder.

Create ( string sFolder, int anchorLoc, IPictureLocationBridge locationParser, string>.Dictionary descriptions, string srcFilename, string sLayoutPos, string sLocationRange, string sCopyright, ITsString tssCaption, PictureLocationRangeType locRangeType, string sScaleFactor ) : ICmPicture

Create a new picture, given string representations of most of the parameters. Used for creating a picture from a Toolbox-style Standard Format import.

Create ( string sFolder, int anchorLoc, IPictureLocationBridge locationParser, string sDescription, string srcFilename, string sLayoutPos, string sLocationRange, string sCopyright, string sCaption, PictureLocationRangeType locRangeType, string sScaleFactor ) : ICmPicture

Create a new picture, given string representations of most of the parameters. Used for creating a picture from a USFM-style Standard Format import.

Create ( string sTextRepOfPicture, string sFolder ) : ICmPicture

Create a new picture, given a text representation (e.g., from the clipboard). NOTE: The caption is put into the default vernacular writing system.

Create ( string sTextRepOfPicture, string sFolder, int anchorLoc, IPictureLocationBridge locationParser ) : ICmPicture

Create a new picture, given a text representation (e.g., from the clipboard). NOTE: The caption is put into the default vernacular writing system.

Private Methods

Method Description
Create ( string srcFilename, ITsString captionTss, string description, PictureLayoutPosition layoutPos, int scaleFactor, PictureLocationRangeType locationRangeType, int locationMin, int locationMax, string copyright, string sFolder, int ws ) : ICmPicture

Initialize a new CmPicture by creating a copy of the file in the given folder and hooking everything up.

Create ( string srcFilename, ITsString captionTss, string description, string sLayoutPos, string sScaleFactor, PictureLocationRangeType locRangeType, int anchorLoc, IPictureLocationBridge locationParser, string sLocationRange, string copyright, string sFolder ) : ICmPicture

Initialize a new CmPicture by creating a copy of the file in the given folder and hooking everything up. Put the caption in the default vernacular writing system.

ParseLayoutPosition ( string token ) : PictureLayoutPosition

Attempts to parse the given token as a layout position string.

ParseLocationRangeType ( string token ) : PictureLocationRangeType

Parses the string representing the type of the location range.

ParsePictureLoc ( string s, PictureLocationRangeType &locType, int &locationMin, int &locationMax ) : void

Parses the picture location range string.

ParseScaleFactor ( string token ) : int

Attempts to parse the given token as a layout position string.

Method Details

Create() public method

Construct a CmPicture for the given file, having the given caption, and located in the given folder.
public Create ( string srcFilename, ITsString captionTss, string sFolder ) : ICmPicture
srcFilename string The path to the original filename (an internal copy will /// be made in this method)
captionTss ITsString The caption
sFolder string The name of the CmFolder where picture should be stored ///
return ICmPicture

Create() public method

Create a new picture, given string representations of most of the parameters. Used for creating a picture from a Toolbox-style Standard Format import.
public Create ( string sFolder, int anchorLoc, IPictureLocationBridge locationParser, string>.Dictionary descriptions, string srcFilename, string sLayoutPos, string sLocationRange, string sCopyright, ITsString tssCaption, PictureLocationRangeType locRangeType, string sScaleFactor ) : ICmPicture
sFolder string The name of the CmFolder where picture should be stored
anchorLoc int The anchor location that the locationParser can use if /// necessary (can be 0).
locationParser IPictureLocationBridge The location parser.
descriptions string>.Dictionary The descriptions in 0 or more writing systems.
srcFilename string The picture filename.
sLayoutPos string The layout position (as a string).
sLocationRange string The location range (as a string).
sCopyright string The copyright.
tssCaption ITsString The caption, in the default vernacular writing system.
locRangeType PictureLocationRangeType Assumed type of the location range.
sScaleFactor string The scale factor (as a string).
return ICmPicture

Create() public method

Create a new picture, given string representations of most of the parameters. Used for creating a picture from a USFM-style Standard Format import.
public Create ( string sFolder, int anchorLoc, IPictureLocationBridge locationParser, string sDescription, string srcFilename, string sLayoutPos, string sLocationRange, string sCopyright, string sCaption, PictureLocationRangeType locRangeType, string sScaleFactor ) : ICmPicture
sFolder string The name of the CmFolder where picture should be stored
anchorLoc int The anchor location that can be used to determine (may be 0).
locationParser IPictureLocationBridge The location parser.
sDescription string Illustration description in English.
srcFilename string The picture filename.
sLayoutPos string The layout position (as a string).
sLocationRange string The location range (as a string).
sCopyright string The copyright.
sCaption string The caption, in the default vernacular writing system.
locRangeType PictureLocationRangeType Assumed type of the location range.
sScaleFactor string The scale factor (as a string).
return ICmPicture

Create() public method

Create a new picture, given a text representation (e.g., from the clipboard). NOTE: The caption is put into the default vernacular writing system.
public Create ( string sTextRepOfPicture, string sFolder ) : ICmPicture
sTextRepOfPicture string Clipboard representation of a picture
sFolder string The name of the CmFolder where picture should be stored ///
return ICmPicture

Create() public method

Create a new picture, given a text representation (e.g., from the clipboard). NOTE: The caption is put into the default vernacular writing system.
public Create ( string sTextRepOfPicture, string sFolder, int anchorLoc, IPictureLocationBridge locationParser ) : ICmPicture
sTextRepOfPicture string Clipboard representation of a picture
sFolder string The name of the CmFolder where picture should be stored
anchorLoc int The anchor location that can be used to determine (may be 0).
locationParser IPictureLocationBridge The picture location parser (can be null).
return ICmPicture